Patient Portal Application API v1

The Oracle Health Data Intelligence Patient Portal Application API allows tenants to configure features of the HealtheLife patient portal.

URL: https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1

Patient Portal Configurations

Operations about Patient Portal Configurations

Retrieve a List of Patient Portal 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/patient-portal-application/v1/patient-portal-configurations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e",
      "domainName": "cernerdemo.patientportal.us-1.healtheintent.com",
      "unauthExperienceEnabled": "true",
      "assigningAuthorities": [
        {
          "name": "member",
          "assigningAuthority": "1.1.1.1.1.1"
        }
      ],
      "signInRedirect": "cernerdemo.patientportal.us-1.healtheintent.com",
      "customHeaders": [
        {
          "locale": "en-US",
          "title": "An official website of the United States government",
          "url": "cernerdemo.patientportal.us.healtheintent.com/va.en-us.html"
        }
      ],
      "useMessagingNotificare": "true",
      "useSchedulingNotificare": "false",
      "usesLogoutRedirect": "true",
      "skipConsumerFlowEnabled": "true",
      "millenniumAliasLookupEnabled": "true"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-portal-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-portal-configurations?offset=0&limit=20"
}

GET /patient-portal-configurations

Retrieves a list of available patient portal configurations for a Health Data Intelligence tenant.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

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

Create a Patient Portal 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/patient-portal-application/v1/patient-portal-configurations', headers: headers, body: {"domainName":"cernerdemo.patientportal.us-1.healtheintent.com","unauthExperienceEnabled":"true","signInRedirect":"cernerdemo.patientportal.us-1.healtheintent.com","useMessagingNotificare":"true","useSchedulingNotificare":"false","usesLogoutRedirect":"true","skipConsumerFlowEnabled":"true","millenniumAliasLookupEnabled":"true","customHeaders":[{"locale":"en-US","title":"An official website of the United States government","url":"cernerdemo.patientportal.us.healtheintent.com/va.en-us.html"}],"assigningAuthorities":[{"name":"member","assigningAuthority":"1.1.1.1.1.1"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-portal-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domainName":"cernerdemo.patientportal.us-1.healtheintent.com","unauthExperienceEnabled":"true","signInRedirect":"cernerdemo.patientportal.us-1.healtheintent.com","useMessagingNotificare":"true","useSchedulingNotificare":"false","usesLogoutRedirect":"true","skipConsumerFlowEnabled":"true","millenniumAliasLookupEnabled":"true","customHeaders":[{"locale":"en-US","title":"An official website of the United States government","url":"cernerdemo.patientportal.us.healtheintent.com/va.en-us.html"}],"assigningAuthorities":[{"name":"member","assigningAuthority":"1.1.1.1.1.1"}]}

{
  "id": "ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e",
  "domainName": "cernerdemo.patientportal.us-1.healtheintent.com",
  "unauthExperienceEnabled": "true",
  "assigningAuthorities": [
    {
      "name": "member",
      "assigningAuthority": "1.1.1.1.1.1"
    }
  ],
  "signInRedirect": "cernerdemo.patientportal.us-1.healtheintent.com",
  "customHeaders": [
    {
      "locale": "en-US",
      "title": "An official website of the United States government",
      "url": "cernerdemo.patientportal.us.healtheintent.com/va.en-us.html"
    }
  ],
  "useMessagingNotificare": "true",
  "useSchedulingNotificare": "false",
  "usesLogoutRedirect": "true",
  "skipConsumerFlowEnabled": "true",
  "millenniumAliasLookupEnabled": "true"
}

POST /patient-portal-configurations

Creates a patient portal configuration for a Health Data Intelligence tenant.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The location of the newly created patient portal configuration.

Delete a Patient Portal Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-portal-configurations/ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-portal-configurations/ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /patient-portal-configurations/{domainName}

Deletes a single patient portal configuration for a Health Data Intelligence tenant.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domainName	path	string	true	N/A	The domain associated with the patient portal configuration.	-

Response Statuses

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

Update a Patient Portal Configuration


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

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

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-portal-configurations/cernerdemo.patientportal.us-1.healtheintent.com', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-portal-configurations/cernerdemo.patientportal.us-1.healtheintent.com \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /patient-portal-configurations/{domainName}

Updates a single patient portal configuration for a Health Data Intelligence tenant.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domainName	path	string	true	N/A	The domain associated with the patient portal configuration.	-

Response Statuses

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

Retrieve a Single Patient Portal 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/patient-portal-application/v1/patient-portal-configurations/cernerdemo.patientportal.us-1.healtheintent.com', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e",
  "domainName": "cernerdemo.patientportal.us-1.healtheintent.com",
  "unauthExperienceEnabled": "true",
  "assigningAuthorities": [
    {
      "name": "member",
      "assigningAuthority": "1.1.1.1.1.1"
    }
  ],
  "signInRedirect": "cernerdemo.patientportal.us-1.healtheintent.com",
  "customHeaders": [
    {
      "locale": "en-US",
      "title": "An official website of the United States government",
      "url": "cernerdemo.patientportal.us.healtheintent.com/va.en-us.html"
    }
  ],
  "useMessagingNotificare": "true",
  "useSchedulingNotificare": "false",
  "usesLogoutRedirect": "true",
  "skipConsumerFlowEnabled": "true",
  "millenniumAliasLookupEnabled": "true"
}

GET /patient-portal-configurations/{domainName}

Retrieves the patient portal configuration for a given domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domainName	path	string	true	N/A	The domain associated with the patient portal configuration.	-

Response Statuses

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

Notification Preferences Configurations

Operations about Notification Preferences Configurations

Retrieve a List of Policy Text 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/patient-portal-application/v1/notification-preference-policy-text-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-definitions?offset=0&limit=20"
}

GET /notification-preference-policy-text-definitions

Retrieve a list of policy text definitions for notification preferences.

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	A collection of policy text definitions.	PolicyTextDefinitions
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Policy Text 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/patient-portal-application/v1/notification-preference-policy-text-definitions', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

POST /notification-preference-policy-text-definitions

Creates a policy text definition for notification preferences.

Parameters

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

Response Statuses

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

Delete a Policy Text 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/patient-portal-application/v1/notification-preference-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /notification-preference-policy-text-definitions/{id}

Deletes a policy text definition with the given policy text definition ID. You cannot delete a policy text definition if it is associated with a policy text configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text definition.	-

Response Statuses

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

Retrieve a Single Policy Text 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/patient-portal-application/v1/notification-preference-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

GET /notification-preference-policy-text-definitions/{id}

Retrieve a single policy text definition for notification preferences.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text definition.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text definition	PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_PolicyTextDefinition
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "notificationPreferencePolicyTextDefinition": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeTexts": [
          {
            "locale": "en-US",
            "text": "Sample Policy Text."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations?offset=0&limit=20"
}

GET /notification-preference-policy-text-configurations

Retrieves a list of policy text configurations for notification preferences with the specified pagination parameters. You can filter this list with the applicationExperienceDomain query parameter.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the policy text definition.	-
applicationExperienceDomain	query	string	false	N/A	The domain to which the tenant ID belongs.	-
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	A collection of policy text definitions.	GetPolicyTextConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Notification Preferences Policy Text 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/patient-portal-application/v1/notification-preference-policy-text-configurations', headers: headers, body: {"notificationPreferencePolicyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"notificationPreferencePolicyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "notificationPreferencePolicyTextDefinitionId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /notification-preference-policy-text-configurations

Creates a policy text configuration for notification preferences.

Parameters

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

Response Statuses

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

Delete a Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /notification-preference-policy-text-configurations/{id}

Deletes a policy text configuration for notification preferences.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-

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 Policy Text 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/patient-portal-application/v1/notification-preference-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"notificationPreferencePolicyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"notificationPreferencePolicyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /notification-preference-policy-text-configurations/{id}

Updates a policy text configuration for notification preferences. You cannot update the application experience domain, only the policy text definition identifier in the configuration is updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
body	body	putNotificationPreferencePolicyTextConfigurations	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 Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "notificationPreferencePolicyTextDefinition": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeTexts": [
      {
        "locale": "en-US",
        "text": "Sample Policy Text."
      }
    ]
  }
}

GET /notification-preference-policy-text-configurations/{id}

Retrieves a single policy text configuration for notification preferences.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
Accept-Language	header	string	false	en-US	The locale of the policy text definition.	-
applicationExperienceDomain	query	string	false	N/A	The domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text definition	PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_GetPolicyTextConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Notification Preferences


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/patient-portal-application/v1/notification-preference-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "organizationId": "Zt47F2XR9",
      "displayModalPromptEnabled": true,
      "modalityTextMessageEnabled": true,
      "modalityPushNotificationEnabled": true,
      "daysSinceLastUpdate": 10,
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-definitions?offset=0&limit=20"
}

GET /notification-preference-definitions

Retrieves a list of notification preferences.

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	A collection of notification preferences.	CommunicationPreferences
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Notification Preference




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/patient-portal-application/v1/notification-preference-definitions', headers: headers, body: {"organizationId":"Zt47F2XR9","displayModalPromptEnabled":true,"modalityTextMessageEnabled":true,"modalityPushNotificationEnabled":true,"daysSinceLastUpdate":10}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"organizationId":"Zt47F2XR9","displayModalPromptEnabled":true,"modalityTextMessageEnabled":true,"modalityPushNotificationEnabled":true,"daysSinceLastUpdate":10}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "organizationId": "Zt47F2XR9",
  "displayModalPromptEnabled": true,
  "modalityTextMessageEnabled": true,
  "modalityPushNotificationEnabled": true,
  "daysSinceLastUpdate": 10,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /notification-preference-definitions

Creates a notification preference.

Parameters

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

Response Statuses

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

Delete a Notification Preference


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/patient-portal-application/v1/notification-preference-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /notification-preference-definitions/{id}

Deletes the notification preference with the given notification preference ID. You cannot delete a notification preference if it is associated with a notification preference configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the communication preference.	-

Response Statuses

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

Retrieve a Single Notification Preference


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/patient-portal-application/v1/notification-preference-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "organizationId": "Zt47F2XR9",
  "displayModalPromptEnabled": true,
  "modalityTextMessageEnabled": true,
  "modalityPushNotificationEnabled": true,
  "daysSinceLastUpdate": 10,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /notification-preference-definitions/{id}

Retrieves a single notification preference.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the communication preference.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single notification preference	PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_CommunicationPreference
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Notification Preference 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/patient-portal-application/v1/notification-preference-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "notificationPreferenceDefinition": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "organizationId": "Zt47F2XR9",
        "displayModalPromptEnabled": true,
        "modalityTextMessageEnabled": true,
        "modalityPushNotificationEnabled": true,
        "daysSinceLastUpdate": 10
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-configurations?offset=0&limit=20"
}

GET /notification-preference-configurations

Retrieves a list of notification preference configurations with the specified pagination parameters. You can filter this list with the applicationExperienceDomain query parameter.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	The domain to which the tenant ID belongs.	-
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	A collection of Notification Preferences.	GetCommunicationPreferenceConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Notification Preference 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/patient-portal-application/v1/notification-preference-configurations', headers: headers, body: {"notificationPreferenceDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"notificationPreferenceDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "notificationPreferenceDefinitionId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /notification-preference-configurations

Creates a notification preference configuration.

Parameters

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

Response Statuses

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

Delete a Notification Preference Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /notification-preference-configurations/{id}

Deletes a notification preference configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the communication preference configuration.	-

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 Notification Preference 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/patient-portal-application/v1/notification-preference-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"notificationPreferenceDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"notificationPreferenceDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /notification-preference-configurations/{id}

Updates a notification preference configuration. The tenant cannot update the application experience domain, only the notification preference ID in the configuration is updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the communication preference configuration.	-
body	body	putNotificationPreferenceConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Notification Preference 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/patient-portal-application/v1/notification-preference-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "notificationPreferenceDefinition": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "organizationId": "Zt47F2XR9",
    "displayModalPromptEnabled": true,
    "modalityTextMessageEnabled": true,
    "modalityPushNotificationEnabled": true,
    "daysSinceLastUpdate": 10
  }
}

GET /notification-preference-configurations/{id}

Retrieves a single notification preference configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the communication preference configuration.	-
applicationExperienceDomain	query	string	false	N/A	The domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Notification Preference configuration	PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_GetCommunicationPreferenceConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of all the Notification Preferences Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-all-configurations',
  query: {
  'applicationExperienceDomain' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-all-configurations?applicationExperienceDomain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "notificationPreferencePolicyTextConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "notificationPreferencePolicyTextDefinition": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "localeTexts": [
            {
              "locale": "en-US",
              "text": "Sample Policy Text."
            }
          ]
        }
      },
      "notificationPreferenceConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "notificationPreferenceDefinition": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "organizationId": "Zt47F2XR9",
          "displayModalPromptEnabled": true,
          "modalityTextMessageEnabled": true,
          "modalityPushNotificationEnabled": true,
          "daysSinceLastUpdate": 10
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-all-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/notification-preference-all-configurations?offset=0&limit=20"
}

GET /notification-preference-all-configurations

Retrieves a list of all the configurations for notification preferences that is paginated using the specified parameters. The list can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	N/A	The locale of the configuration.	-
applicationExperienceDomain	query	string	true	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of Notification Preferences Configs.	Configurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Millennium Patient Notifications

Operations about Millennium Patient Notifications

Create Cerner Millennium Patient Secure Message Notifications




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/patient-portal-application/v1/millennium-patient-notifications/messages', headers: headers, body: {"patient_message_notifications":[{"patient_id":"127655","domain":"dev.healtheintent.com","message_identifier":"9462956898","reminder_date":"2022-03-15T12:35:12Z"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-patient-notifications/messages \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"patient_message_notifications":[{"patient_id":"127655","domain":"dev.healtheintent.com","message_identifier":"9462956898","reminder_date":"2022-03-15T12:35:12Z"}]}

POST /millennium-patient-notifications/messages

Creates Cerner Millennium patient Secure Message notifications.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create Cerner Millennium Patient Health Record Notifications




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/patient-portal-application/v1/millennium-patient-notifications/events', headers: headers, body: {"millennium_patient_id":"12560038","millennium_organization":"83617","millennium_domain":"dev.healtheintent.com","event_ids":["9462956898"],"notification_type":"clinical_notes","notification_requested_at":"2022-03-15T12:23:12Z"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-patient-notifications/events \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"millennium_patient_id":"12560038","millennium_organization":"83617","millennium_domain":"dev.healtheintent.com","event_ids":["9462956898"],"notification_type":"clinical_notes","notification_requested_at":"2022-03-15T12:23:12Z"}

POST /millennium-patient-notifications/events

Creates Cerner Millennium patient Health Record notifications.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
202	Accepted	Accepted	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Messaging Policies

Messaging policies allow the administrator of the patient portal to configure the text that is displayed on the various messaging pages.

Create a Messaging Policy




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/patient-portal-application/v1/messaging-policies', headers: headers, body: {"locale":"en-US","policyType":"INBOX","domain":"carekc.consumerportal.devhealtheintent.com","shortPolicyText":"The inbox contains updates or responses received from care providers.","longPolicyText":"The inbox contains updates or responses received from care providers. Secure messages are checked during times when the providers are in office. Every effort will be made to respond within 24 hours during regular business hours."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/messaging-policies \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"locale":"en-US","policyType":"INBOX","domain":"carekc.consumerportal.devhealtheintent.com","shortPolicyText":"The inbox contains updates or responses received from care providers.","longPolicyText":"The inbox contains updates or responses received from care providers. Secure messages are checked during times when the providers are in office. Every effort will be made to respond within 24 hours during regular business hours."}

{
  "id": "6f662f5b-6f75-43eb-a9c5-9fe22827dcda",
  "locale": "en-CA",
  "policyType": "INBOX",
  "domain": "carekc.consumerportal.devhealtheintent.com",
  "shortPolicyText": "The inbox contains updates or responses received from care providers.",
  "longPolicyText": "The inbox contains updates or responses received from care providers. Secure messages are checked during times when the providers are in office. Every effort will be made to respond within 24 hours during regular business hours.",
  "createdAt": "2021-01-20T05:40:02.000Z",
  "updatedAt": "2021-01-20T05:40:02.000Z"
}

POST /messaging-policies

Creates a messaging policy.

Parameters

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

Response Statuses

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

Retrieve a List of Messaging Policies


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/patient-portal-application/v1/messaging-policies', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "6f662f5b-6f75-43eb-a9c5-9fe22827dcda",
      "locale": "en-CA",
      "policyType": "INBOX",
      "domain": "carekc.consumerportal.devhealtheintent.com",
      "shortPolicyText": "The inbox contains updates or responses received from care providers.",
      "longPolicyText": "The inbox contains updates or responses received from care providers. Secure messages are checked during times when the providers are in office. Every effort will be made to respond within 24 hours during regular business hours.",
      "createdAt": "2021-01-20T05:40:02.000Z",
      "updatedAt": "2021-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/v1/messaging-policies?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/v1/messaging-policies?offset=0&limit=20"
}

GET /messaging-policies

Retrieves a list of messaging policies.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
locale	query	string	false	N/A	Locale by which the messaging policies are to be filtered.	-
domain	query	string	false	N/A	Domain by which the messaging policies are to be filtered.	-
policyType	query	string	false	N/A	Policy type by which the messaging policies are to be filtered.	INBOX, SENT, TRASH, SUCCESS, GENERAL
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	MessagingPolicies
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Messaging Policy


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

DELETE /messaging-policies/{messagingPolicyId}

Deletes the messaging policy with the specified ID.

Parameters

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

Response Statuses

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

Update a Messaging Policy




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/patient-portal-application/v1/messaging-policies/1a857d33-5b74-4c76-9a60-a008ea652cc6', headers: headers, body: {"locale":"en-US","policyType":"INBOX","domain":"carekc.consumerportal.devhealtheintent.com","shortPolicyText":"The inbox contains updates or responses received from care providers.","longPolicyText":"The inbox contains updates or responses received from care providers. Secure messages are checked during times when the providers are in office. Every effort will be made to respond within 24 hours during regular business hours."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/messaging-policies/1a857d33-5b74-4c76-9a60-a008ea652cc6 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"locale":"en-US","policyType":"INBOX","domain":"carekc.consumerportal.devhealtheintent.com","shortPolicyText":"The inbox contains updates or responses received from care providers.","longPolicyText":"The inbox contains updates or responses received from care providers. Secure messages are checked during times when the providers are in office. Every effort will be made to respond within 24 hours during regular business hours."}

PUT /messaging-policies/{messagingPolicyId}

Updates the messaging policy by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
messagingPolicyId	path	string	true	N/A	The ID of the messaging policy.	-
body	body	putMessagingPolicies	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Messaging Policy


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

{
  "id": "6f662f5b-6f75-43eb-a9c5-9fe22827dcda",
  "locale": "en-CA",
  "policyType": "INBOX",
  "domain": "carekc.consumerportal.devhealtheintent.com",
  "shortPolicyText": "The inbox contains updates or responses received from care providers.",
  "longPolicyText": "The inbox contains updates or responses received from care providers. Secure messages are checked during times when the providers are in office. Every effort will be made to respond within 24 hours during regular business hours.",
  "createdAt": "2021-01-20T05:40:02.000Z",
  "updatedAt": "2021-01-20T05:40:02.000Z"
}

GET /messaging-policies/{messagingPolicyId}

Retrieves a single messaging policy by ID.

Parameters

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

Response Statuses

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

Cerner Millennium Configuration

The Cerner Millennium Configuration endpoints allow tenants to configure the following items:

Cerner Millennium configurations: Cerner Millennium configurations allow tenants to connect to an existing Cerner Millennium domain without protocol. This allows users to retrieve authorization headers, the Cerner Millennium URL, the Patient Portal API URL, and the Cerner Millennium tenant ID, all of which are required to send service requests to the associated Cerner Millennium domain.
Cerner Millennium OAuth configurations: Cerner Millennium OAuth configurations allow tenants to create and retrieve the OAuth configuration for a given Cerner Millennium domain. This includes storing and updating the consumer key, consumer secret, and Cerner Millennium tenant ID required to send authorized requests to a given Cerner Millennium domain.

Retrieve a List of Cerner Millennium OAuth 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/patient-portal-application/v1/millennium-oauth-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-oauth-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "a89ca32d-12ef-42eb-12ad-46a0c2b015f5",
      "consumerKey": "com.cerner.domain",
      "millenniumTenantId": "2b116b34-5ad4-4a3e-8226-80bd580315d9",
      "isMillenniumNonProd": true
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-oauth-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-oauth-configurations?offset=0&limit=20"
}

GET /millennium-oauth-configurations

Retrieves a list of Cerner Millennium OAuth configurations for a given tenant.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

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

Create a Cerner Millennium OAuth 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/patient-portal-application/v1/millennium-oauth-configurations', headers: headers, body: {"consumerKey":"com.cerner.domain","consumerSecret":"thisisatestconsumersecret","millenniumTenantId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","isMillenniumNonProd":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-oauth-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumerKey":"com.cerner.domain","consumerSecret":"thisisatestconsumersecret","millenniumTenantId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","isMillenniumNonProd":true}

{
  "id": "a89ca32d-12ef-42eb-12ad-46a0c2b015f5",
  "consumerKey": "com.cerner.domain",
  "millenniumTenantId": "2b116b34-5ad4-4a3e-8226-80bd580315d9",
  "isMillenniumNonProd": true
}

POST /millennium-oauth-configurations

Creates a Cerner Millennium OAuth configuration.

Parameters

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

Response Statuses

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

Update a Cerner Millennium OAuth 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/patient-portal-application/v1/millennium-oauth-configurations/f37a48df-26c2-451e-8e45-f495addef578', headers: headers, body: {"consumerKey":"com.cerner.domain","consumerSecret":"2b116b34-5ad4-4a3e-8226-80bd580315d9","millenniumTenantId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","isMillenniumNonProd":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-oauth-configurations/f37a48df-26c2-451e-8e45-f495addef578 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"consumerKey":"com.cerner.domain","consumerSecret":"2b116b34-5ad4-4a3e-8226-80bd580315d9","millenniumTenantId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","isMillenniumNonProd":true}

PUT /millennium-oauth-configurations/{id}

Updates the Cerner Millennium OAuth configuration by its ID.

Important! Cerner recommends that this operation be used only in rare cases when the instance of the Patient Portal application is not live or when a change to this configuration is preferred over creating a new configuration. If the configuration is updated, the configuration is currently used by a live website, and the consumer key and secret function for one domain and not another, the connection to Cerner Millennium could be interrupted. To prevent this, Cerner recommends that a new configuration be created unless you are certain that the connection will not be interrupted by the change.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the Cerner Millennium OAuth configuration.	-
body	body	putMillenniumOauthConfigurations	true	N/A	No description	-

Response Statuses

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

Delete a Cerner Millennium OAuth Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-oauth-configurations/f37a48df-26c2-451e-8e45-f495addef578', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-oauth-configurations/f37a48df-26c2-451e-8e45-f495addef578 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /millennium-oauth-configurations/{id}

Deletes a Cerner Millennium OAuth configuration by its ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the Cerner Millennium OAuth configuration.	-

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

Retrieve a Single Cerner Millennium OAuth 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/patient-portal-application/v1/millennium-oauth-configurations/f37a48df-26c2-451e-8e45-f495addef578', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-oauth-configurations/f37a48df-26c2-451e-8e45-f495addef578 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "a89ca32d-12ef-42eb-12ad-46a0c2b015f5",
  "consumerKey": "com.cerner.domain",
  "millenniumTenantId": "2b116b34-5ad4-4a3e-8226-80bd580315d9",
  "isMillenniumNonProd": true
}

GET /millennium-oauth-configurations/{id}

Retrieves a Cerner Millennium OAuth configuration by its ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the Cerner Millennium OAuth configuration.	-

Response Statuses

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

Retrieve a List of Cerner Millennium 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/patient-portal-application/v1/millennium-configurations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "a89ca32d-12ef-42eb-12ad-46a0c2b015f5",
      "domainUri": "abc.patientportal.us.devhealtheintent.com",
      "millenniumConfig": {
        "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-configurations?offset=0&limit=20"
}

GET /millennium-configurations

Retrieves a list of Cerner Millennium configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domainUri	query	string	false	N/A	Filters the list of configurations to only those associated with a specific domain name.	-
millenniumTenantId	query	string	false	N/A	Filters the list of configurations to only those associated with a specific Cerner Millennium tenant 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	MillenniumConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Cerner Millennium 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/patient-portal-application/v1/millennium-configurations', headers: headers, body: {"domainUri":"abc.us.devhealtheintent.com","millenniumConfig":{"id":"f89fa3dd-0000-494b-1111-4640ccc081e3"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domainUri":"abc.us.devhealtheintent.com","millenniumConfig":{"id":"f89fa3dd-0000-494b-1111-4640ccc081e3"}}

{
  "id": "a89ca32d-12ef-42eb-12ad-46a0c2b015f5",
  "domainUri": "abc.patientportal.us.devhealtheintent.com",
  "millenniumConfig": {
    "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
  }
}

POST /millennium-configurations

Creates a new domain name entry associated with a Cerner Millennium OAuth configuration.

Parameters

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

Response Statuses

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

Update a Cerner Millennium 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/patient-portal-application/v1/millennium-configurations/2fb52376-cadd-3a98-8181-61cb77fdc3a3', headers: headers, body: {"millenniumConfig":{"id":"f89fa3dd-0000-494b-1111-4640ccc081e3"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-configurations/2fb52376-cadd-3a98-8181-61cb77fdc3a3 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"millenniumConfig":{"id":"f89fa3dd-0000-494b-1111-4640ccc081e3"}}

PUT /millennium-configurations/{configurationId}

Updates the Cerner Millennium configuration details for a given ID.

Parameters

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

Response Statuses

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

Remove a Cerner Millennium Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-configurations/2fb52376-cadd-3a98-8181-61cb77fdc3a3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-configurations/2fb52376-cadd-3a98-8181-61cb77fdc3a3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /millennium-configurations/{configurationId}

Deletes the Cerner Millennium configuration details for a given ID.

Parameters

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

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

Retrieve a Single Cerner Millennium 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/patient-portal-application/v1/millennium-configurations/2fb52376-cadd-3a98-8181-61cb77fdc3a3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/millennium-configurations/2fb52376-cadd-3a98-8181-61cb77fdc3a3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "a89ca32d-12ef-42eb-12ad-46a0c2b015f5",
  "domainUri": "abc.patientportal.us.devhealtheintent.com",
  "millenniumConfig": {
    "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
  }
}

GET /millennium-configurations/{configurationId}

Retrieves the Cerner Millennium configuration details for a given ID.

Parameters

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

Response Statuses

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

Video Visit Configuration

Video visit configurations allow tenants to customize the widget image, widget text, and instructions on the start page of the video visit application and to configure the following items for video visits:

Amwell configuration: Amwell configurations contain the tenant account information for Amwell and the settings required to use the Amwell software development kit (SDK). This is required for on-demand and scheduled video visits.
Cerner Millennium electronic health record (EHR) configuration: Cerner Millennium EHR configurations allow tenants to connect patients’ Cerner Millennium medical records with Amwell video visits.
HealtheLife enrollment configuration: HealtheLife enrollment configurations contain the information required for tenants to save and retrieve information about video visits in the Patient Portal application.

Retrieve a List of Amwell 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/patient-portal-application/v1/amwell-configurations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2daedd88-9b54-4b7e-9303-9db9e8f99f4e",
      "sdk": {
        "key": "ab225312",
        "mobileKey": "ds133422",
        "apiUrl": "https://iot20.amwellintegration.com"
      },
      "enrollment": {
        "user": "cern",
        "password": "Gbt3fC7",
        "url": "https://iot20.amwellintegration.com/ws/realtimeIntegration"
      },
      "converge": {
        "appId": "appId225312"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/amwell-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/amwell-configurations?offset=0&limit=20"
}

GET /amwell-configurations

Retrieves a list of Amwell configurations that satisfy the specified parameters.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	Filters by the domain of the Amwell configuration.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

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

Create an Amwell 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/patient-portal-application/v1/amwell-configurations', headers: headers, body: {"sdk":{"key":"ab225312","mobileKey":"ds133422","apiUrl":"https://iot20.amwellintegration.com"},"enrollment":{"user":"cern","password":"Gbt3fC7","url":"https://iot20.amwellintegration.com/ws/realtimeIntegration"},"converge":{"appId":"appId225312"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/amwell-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"sdk":{"key":"ab225312","mobileKey":"ds133422","apiUrl":"https://iot20.amwellintegration.com"},"enrollment":{"user":"cern","password":"Gbt3fC7","url":"https://iot20.amwellintegration.com/ws/realtimeIntegration"},"converge":{"appId":"appId225312"}}

{
  "id": "2daedd88-9b54-4b7e-9303-9db9e8f99f4e",
  "sdk": {
    "key": "ab225312",
    "mobileKey": "ds133422",
    "apiUrl": "https://iot20.amwellintegration.com"
  },
  "enrollment": {
    "user": "cern",
    "password": "Gbt3fC7",
    "url": "https://iot20.amwellintegration.com/ws/realtimeIntegration"
  },
  "converge": {
    "appId": "appId225312"
  }
}

POST /amwell-configurations

Creates an Amwell configuration. These configurations are used by the video visit application to interact with Amwell.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The location of the newly created Amwell configuration.

Update an Amwell 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/patient-portal-application/v1/amwell-configurations/2daedd88-9b54-4b7e-9303-9db9e8f99f4e', headers: headers, body: {"sdk":{"key":"ab225312","mobileKey":"ds133422","apiUrl":"https://iot20.amwellintegration.com"},"enrollment":{"user":"cern","password":"Gbt3fC7","url":"https://iot20.amwellintegration.com/ws/realtimeIntegration"},"converge":{"appId":"appId225312"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/amwell-configurations/2daedd88-9b54-4b7e-9303-9db9e8f99f4e \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"sdk":{"key":"ab225312","mobileKey":"ds133422","apiUrl":"https://iot20.amwellintegration.com"},"enrollment":{"user":"cern","password":"Gbt3fC7","url":"https://iot20.amwellintegration.com/ws/realtimeIntegration"},"converge":{"appId":"appId225312"}}

PUT /amwell-configurations/{id}

Updates a single Amwell configuration by its ID.

Parameters

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

Response Statuses

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

Delete an Amwell Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/amwell-configurations/2daedd88-9b54-4b7e-9303-9db9e8f99f4e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/amwell-configurations/2daedd88-9b54-4b7e-9303-9db9e8f99f4e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /amwell-configurations/{id}

Deletes a single Amwell configuration by its ID.

Parameters

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

Response Statuses

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

Retrieve a Single Amwell 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/patient-portal-application/v1/amwell-configurations/2daedd88-9b54-4b7e-9303-9db9e8f99f4e', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/amwell-configurations/2daedd88-9b54-4b7e-9303-9db9e8f99f4e \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2daedd88-9b54-4b7e-9303-9db9e8f99f4e",
  "sdk": {
    "key": "ab225312",
    "mobileKey": "ds133422",
    "apiUrl": "https://iot20.amwellintegration.com"
  },
  "enrollment": {
    "user": "cern",
    "password": "Gbt3fC7",
    "url": "https://iot20.amwellintegration.com/ws/realtimeIntegration"
  },
  "converge": {
    "appId": "appId225312"
  }
}

GET /amwell-configurations/{id}

Retrieves a single Amwell configuration by its ID.

Parameters

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

Response Statuses

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

Retrieve a List of Video Visit 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/patient-portal-application/v1/video-visit-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/video-visit-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "97b5a802-1447-4f97-af02-7547ac0fc00b",
      "domain": "cckc.patientportal.us.devhealtheintent.com",
      "widgetImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg",
      "widgetTexts": [
        {
          "locale": "en-US",
          "content": "Click here to open a video visit."
        }
      ],
      "startPageImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/startPage.jpg",
      "startPageHeading": [
        {
          "locale": "en-US",
          "content": "Welcome!"
        }
      ],
      "startPageHtml": [
        {
          "locale": "en-US",
          "content": "<div>\n  <p>To start a video visit, ensure that you have the following information:</p>\n  <ul>\n    <li>Your preferred pharmacy</li>\n    <li>Your insurance card</li>\n    <li>Your credit card</li>\n  </ul>\n </div>\n"
        }
      ],
      "waitingRoomTexts": [
        {
          "locale": "en-US",
          "content": "Thanks for waiting!"
        }
      ],
      "paymentPageUrl": "https://d1zjhrj0if0ph.cloudfront.net/card-details.html",
      "waitingRoomImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.jpg",
      "waitingRoomVideoUrl": "https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.mp4",
      "newDependentEnabled": true,
      "newDependentDisclaimerTexts": [
        {
          "locale": "en-US",
          "content": "I certify that I am the legal parent."
        }
      ],
      "amwellConfiguration": {
        "id": "2daedd88-9b54-4b7e-9303-9db9e8f99f4e",
        "sdk": {
          "key": "ab225312",
          "mobileKey": "ds133422",
          "apiUrl": "https://iot20.amwellintegration.com"
        },
        "enrollment": {
          "user": "cern",
          "password": "Gbt3fC7",
          "url": "https://iot20.amwellintegration.com/ws/realtimeIntegration"
        },
        "converge": {
          "appId": "appId225312"
        }
      },
      "healthelifeEnrollmentConfiguration": {
        "healthelifeEnrollmentOrgId": "BHur78nn"
      },
      "millenniumEhrConfiguration": {
        "millenniumPatientConfiguration": {
          "facilityOrganizationId": "6238450",
          "mrnAliasPoolId": "4048131",
          "mrnAliasTypeCd": "MRN",
          "federatedPrincipalPoolId": "677839476"
        },
        "millenniumEncounterConfiguration": {
          "typeCd": "Gbt3fC7",
          "locationId": "JI7934",
          "aliasPoolId": "778GFbv63",
          "finAliasPoolId": "4048132",
          "finAliasTypeCd": "FIN NBR"
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/portal-application/v1/video-visit-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/portal-application/v1/video-visit-configurations?offset=0&limit=20"
}

GET /video-visit-configurations

Retrieves all the available video visit configurations that satisfy the specified parameters.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	Filters by the domain of the video visit configuration.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

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

Create a Video Visit 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/patient-portal-application/v1/video-visit-configurations', headers: headers, body: {"domain":"cckc.patientportal.us.devhealtheintent.com","widgetImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg","widgetTexts":[{"locale":"en-US","content":"Click here to open a video visit."}],"startPageImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/startPage.jpg","startPageHeading":[{"locale":"en-US","content":"Welcome!"}],"startPageHtml":[{"locale":"en-US","content":"<div>\n  <p>To start a video visit, ensure that you have the following information:</p>\n  <ul>\n    <li>Your preferred pharmacy</li>\n    <li>Your insurance card</li>\n    <li>Your credit card</li>\n  </ul>\n </div>\n"}],"waitingRoomTexts":[{"locale":"en-US","content":"Thanks for waiting!"}],"waitingRoomImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.jpg","waitingRoomVideoUrl":"https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.mp4","paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","newDependentEnabled":true,"newDependentDisclaimerTexts":[{"locale":"en-US","content":"I certify that I am the legal parent."}],"amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"},"healthelifeEnrollmentConfiguration":{"healthelifeEnrollmentOrgId":"BHur78nn"},"millenniumEhrConfiguration":{"millenniumPatientConfiguration":{"facilityOrganizationId":"6238450","mrnAliasPoolId":"4048131","mrnAliasTypeCd":"MRN","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63","finAliasPoolId":"4048132","finAliasTypeCd":"FIN NBR"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/video-visit-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"cckc.patientportal.us.devhealtheintent.com","widgetImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg","widgetTexts":[{"locale":"en-US","content":"Click here to open a video visit."}],"startPageImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/startPage.jpg","startPageHeading":[{"locale":"en-US","content":"Welcome!"}],"startPageHtml":[{"locale":"en-US","content":"<div>\n  <p>To start a video visit, ensure that you have the following information:</p>\n  <ul>\n    <li>Your preferred pharmacy</li>\n    <li>Your insurance card</li>\n    <li>Your credit card</li>\n  </ul>\n </div>\n"}],"waitingRoomTexts":[{"locale":"en-US","content":"Thanks for waiting!"}],"waitingRoomImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.jpg","waitingRoomVideoUrl":"https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.mp4","paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","newDependentEnabled":true,"newDependentDisclaimerTexts":[{"locale":"en-US","content":"I certify that I am the legal parent."}],"amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"},"healthelifeEnrollmentConfiguration":{"healthelifeEnrollmentOrgId":"BHur78nn"},"millenniumEhrConfiguration":{"millenniumPatientConfiguration":{"facilityOrganizationId":"6238450","mrnAliasPoolId":"4048131","mrnAliasTypeCd":"MRN","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63","finAliasPoolId":"4048132","finAliasTypeCd":"FIN NBR"}}}

{
  "id": "97b5a802-1447-4f97-af02-7547ac0fc00b",
  "domain": "cckc.patientportal.us.devhealtheintent.com",
  "widgetImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg",
  "widgetTexts": [
    {
      "locale": "en-US",
      "content": "Click here to open a video visit."
    }
  ],
  "startPageImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/startPage.jpg",
  "startPageHeading": [
    {
      "locale": "en-US",
      "content": "Welcome!"
    }
  ],
  "startPageHtml": [
    {
      "locale": "en-US",
      "content": "<div>\n  <p>To start a video visit, ensure that you have the following information:</p>\n  <ul>\n    <li>Your preferred pharmacy</li>\n    <li>Your insurance card</li>\n    <li>Your credit card</li>\n  </ul>\n </div>\n"
    }
  ],
  "waitingRoomTexts": [
    {
      "locale": "en-US",
      "content": "Thanks for waiting!"
    }
  ],
  "paymentPageUrl": "https://d1zjhrj0if0ph.cloudfront.net/card-details.html",
  "waitingRoomImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.jpg",
  "waitingRoomVideoUrl": "https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.mp4",
  "newDependentEnabled": true,
  "newDependentDisclaimerTexts": [
    {
      "locale": "en-US",
      "content": "I certify that I am the legal parent."
    }
  ],
  "amwellConfiguration": {
    "id": "2daedd88-9b54-4b7e-9303-9db9e8f99f4e",
    "sdk": {
      "key": "ab225312",
      "mobileKey": "ds133422",
      "apiUrl": "https://iot20.amwellintegration.com"
    },
    "enrollment": {
      "user": "cern",
      "password": "Gbt3fC7",
      "url": "https://iot20.amwellintegration.com/ws/realtimeIntegration"
    },
    "converge": {
      "appId": "appId225312"
    }
  },
  "healthelifeEnrollmentConfiguration": {
    "healthelifeEnrollmentOrgId": "BHur78nn"
  },
  "millenniumEhrConfiguration": {
    "millenniumPatientConfiguration": {
      "facilityOrganizationId": "6238450",
      "mrnAliasPoolId": "4048131",
      "mrnAliasTypeCd": "MRN",
      "federatedPrincipalPoolId": "677839476"
    },
    "millenniumEncounterConfiguration": {
      "typeCd": "Gbt3fC7",
      "locationId": "JI7934",
      "aliasPoolId": "778GFbv63",
      "finAliasPoolId": "4048132",
      "finAliasTypeCd": "FIN NBR"
    }
  }
}

POST /video-visit-configurations

Creates a video visit configuration.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The location of the newly created video visit configuration.

Update a Video Visit 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/patient-portal-application/v1/video-visit-configurations/97b5a802-1447-4f97-af02-7547ac0fc00b', headers: headers, body: {"domain":"cckc.patientportal.us.devhealtheintent.com","widgetImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg","widgetTexts":[{"locale":"en-US","content":"Click here to open a video visit."}],"startPageImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/startPage.jpg","startPageHeading":[{"locale":"en-US","content":"Welcome!"}],"startPageHtml":[{"locale":"en-US","content":"<div>\n  <p>To start a video visit, ensure that you have the following information:</p>\n  <ul>\n    <li>Your preferred pharmacy</li>\n    <li>Your insurance card</li>\n    <li>Your credit card</li>\n  </ul>\n </div>\n"}],"waitingRoomTexts":[{"locale":"en-US","content":"Thanks for waiting!"}],"waitingRoomImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.jpg","waitingRoomVideoUrl":"https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.mp4","paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","newDependentEnabled":true,"newDependentDisclaimerTexts":[{"locale":"en-US","content":"I certify that I am the legal parent."}],"amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"},"healthelifeEnrollmentConfiguration":{"healthelifeEnrollmentOrgId":"BHur78nn"},"millenniumEhrConfiguration":{"millenniumPatientConfiguration":{"facilityOrganizationId":"6238450","mrnAliasPoolId":"4048131","mrnAliasTypeCd":"MRN","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63","finAliasPoolId":"4048132","finAliasTypeCd":"FIN NBR"}}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/video-visit-configurations/97b5a802-1447-4f97-af02-7547ac0fc00b \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"cckc.patientportal.us.devhealtheintent.com","widgetImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg","widgetTexts":[{"locale":"en-US","content":"Click here to open a video visit."}],"startPageImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/startPage.jpg","startPageHeading":[{"locale":"en-US","content":"Welcome!"}],"startPageHtml":[{"locale":"en-US","content":"<div>\n  <p>To start a video visit, ensure that you have the following information:</p>\n  <ul>\n    <li>Your preferred pharmacy</li>\n    <li>Your insurance card</li>\n    <li>Your credit card</li>\n  </ul>\n </div>\n"}],"waitingRoomTexts":[{"locale":"en-US","content":"Thanks for waiting!"}],"waitingRoomImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.jpg","waitingRoomVideoUrl":"https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.mp4","paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","newDependentEnabled":true,"newDependentDisclaimerTexts":[{"locale":"en-US","content":"I certify that I am the legal parent."}],"amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"},"healthelifeEnrollmentConfiguration":{"healthelifeEnrollmentOrgId":"BHur78nn"},"millenniumEhrConfiguration":{"millenniumPatientConfiguration":{"facilityOrganizationId":"6238450","mrnAliasPoolId":"4048131","mrnAliasTypeCd":"MRN","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63","finAliasPoolId":"4048132","finAliasTypeCd":"FIN NBR"}}}

PUT /video-visit-configurations/{id}

Updates a single video visit configuration by its ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the video visit configuration.	-
body	body	putVideoVisitConfigurations	true	N/A	No description	-

Response Statuses

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

Delete a Video Visit Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/video-visit-configurations/97b5a802-1447-4f97-af02-7547ac0fc00b', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/video-visit-configurations/97b5a802-1447-4f97-af02-7547ac0fc00b \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /video-visit-configurations/{id}

Deletes a single video visit configuration by its ID.

Parameters

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

Response Statuses

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

Retrieve a Single Video Visit 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/patient-portal-application/v1/video-visit-configurations/97b5a802-1447-4f97-af02-7547ac0fc00b', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/video-visit-configurations/97b5a802-1447-4f97-af02-7547ac0fc00b \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "97b5a802-1447-4f97-af02-7547ac0fc00b",
  "domain": "cckc.patientportal.us.devhealtheintent.com",
  "widgetImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg",
  "widgetTexts": [
    {
      "locale": "en-US",
      "content": "Click here to open a video visit."
    }
  ],
  "startPageImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/startPage.jpg",
  "startPageHeading": [
    {
      "locale": "en-US",
      "content": "Welcome!"
    }
  ],
  "startPageHtml": [
    {
      "locale": "en-US",
      "content": "<div>\n  <p>To start a video visit, ensure that you have the following information:</p>\n  <ul>\n    <li>Your preferred pharmacy</li>\n    <li>Your insurance card</li>\n    <li>Your credit card</li>\n  </ul>\n </div>\n"
    }
  ],
  "waitingRoomTexts": [
    {
      "locale": "en-US",
      "content": "Thanks for waiting!"
    }
  ],
  "paymentPageUrl": "https://d1zjhrj0if0ph.cloudfront.net/card-details.html",
  "waitingRoomImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.jpg",
  "waitingRoomVideoUrl": "https://d292eo2ec5lzlq.cloudfront.net/waitingRoom.mp4",
  "newDependentEnabled": true,
  "newDependentDisclaimerTexts": [
    {
      "locale": "en-US",
      "content": "I certify that I am the legal parent."
    }
  ],
  "amwellConfiguration": {
    "id": "2daedd88-9b54-4b7e-9303-9db9e8f99f4e",
    "sdk": {
      "key": "ab225312",
      "mobileKey": "ds133422",
      "apiUrl": "https://iot20.amwellintegration.com"
    },
    "enrollment": {
      "user": "cern",
      "password": "Gbt3fC7",
      "url": "https://iot20.amwellintegration.com/ws/realtimeIntegration"
    },
    "converge": {
      "appId": "appId225312"
    }
  },
  "healthelifeEnrollmentConfiguration": {
    "healthelifeEnrollmentOrgId": "BHur78nn"
  },
  "millenniumEhrConfiguration": {
    "millenniumPatientConfiguration": {
      "facilityOrganizationId": "6238450",
      "mrnAliasPoolId": "4048131",
      "mrnAliasTypeCd": "MRN",
      "federatedPrincipalPoolId": "677839476"
    },
    "millenniumEncounterConfiguration": {
      "typeCd": "Gbt3fC7",
      "locationId": "JI7934",
      "aliasPoolId": "778GFbv63",
      "finAliasPoolId": "4048132",
      "finAliasTypeCd": "FIN NBR"
    }
  }
}

GET /video-visit-configurations/{id}

Retrieves a single video visit configuration by its ID.

Parameters

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

Response Statuses

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

Appointment Types

Appointment types are commonly booked appointments, for example, flu shot, blood test, or eye exam. They allow users to view and book appointments that are trending or frequently booked by other patients. They also allow tenants to guide users toward appointments based on campaigns or seasonal demands.

Retrieve a List of HealtheLife Appointment Types


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/patient-portal-application/v1/appointment-types', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "millenniumAppointmentTypes": {
        "synonymCode": "4356278376"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-types?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-types?offset=0&limit=20"
}

GET /appointment-types

Retrieves a list of all HealtheLife appointment types that is paginated per the specified parameters.

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	A collection of appointment types.	AppointmentTypes
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Appointment Type




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/patient-portal-application/v1/appointment-types', headers: headers, body: {"millenniumAppointmentTypes":[{"synonymCode":"4356278376"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-types \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"millenniumAppointmentTypes":[{"synonymCode":"4356278376"}]}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "millenniumAppointmentTypes": {
    "synonymCode": "4356278376"
  }
}

POST /appointment-types

Creates a HealtheLife appointment type with a minimum of one and a maximum of six Cerner Millennium appointment types.

Parameters

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

Response Statuses

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

Delete a HealtheLife Appointment Type


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/patient-portal-application/v1/appointment-types/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-types/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /appointment-types/{id}

Deletes the HealtheLife appointment type with the provided appointment type ID. If the HealtheLife appointment type is associated with an appointment type configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the appointment type.	-

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 HealtheLife Appointment Type


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/patient-portal-application/v1/appointment-types/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-types/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "millenniumAppointmentTypes": {
    "synonymCode": "4356278376"
  }
}

GET /appointment-types/{id}

Retrieves the HealtheLife appointment type with the provided appointment type ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the appointment type.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single appointment type	PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypes_AppointmentType
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Appointment Type Configurations

Appointment type configurations enable configuration of the domains in which appointment types are available.

Retrieve a List of HealtheLife Appointment Type 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/patient-portal-application/v1/appointment-type-configs', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "appointmentTypeId": "262038ed-c304-4737-93d9-55615b6a1ce6",
      "domainName": "dev3.healthelife-appointment-type-service.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-type-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-type-configs?offset=0&limit=20"
}

GET /appointment-type-configs

Retrieves a list of all HealtheLife appointment type configurations that are paginated per the specified parameters and allows the user to filter with domain as a query parameter.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domainName	query	string	false	N/A	The domain to which the HealtheLife appointment configurations belong.	-
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	A collection of appointment type configurations.	AppointmentTypeConfigs
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Appointment Type 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/patient-portal-application/v1/appointment-type-configs', headers: headers, body: {"appointmentTypeId":"262038ed-c304-4737-93d9-55615b6a1ce6","domainName":"dev3.healthelife-appointment-type-service.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-type-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"appointmentTypeId":"262038ed-c304-4737-93d9-55615b6a1ce6","domainName":"dev3.healthelife-appointment-type-service.com"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "appointmentTypeId": "262038ed-c304-4737-93d9-55615b6a1ce6",
  "domainName": "dev3.healthelife-appointment-type-service.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /appointment-type-configs

Creates an HealtheLife appointment type configuration by associating the domain with the given appointment type ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The appointment type configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypeConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a HealtheLife Appointment Type 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/patient-portal-application/v1/appointment-type-configs/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers, body: {"appointmentTypeId":"262038ed-c304-4737-93d9-55615b6a1ce6","domainName":"dev3.healthelife-appointment-type-service.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-type-configs/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"appointmentTypeId":"262038ed-c304-4737-93d9-55615b6a1ce6","domainName":"dev3.healthelife-appointment-type-service.com"}

PUT /appointment-type-configs/{id}

Updates the HealtheLife appointment type configuration for a given appointment type configuration ID where the user is not allowed to update the domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the appointment type configuration.	-
body	body	putAppointmentTypeConfigs	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 HealtheLife Appointment Type Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-type-configs/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-type-configs/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /appointment-type-configs/{id}

Deletes the HealtheLife appointment type configuration for a given appointment type configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the appointment type configuration.	-

Response Statuses

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

Retrieve a Single HealtheLife Appointment Type 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/patient-portal-application/v1/appointment-type-configs/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-type-configs/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "appointmentTypeId": "262038ed-c304-4737-93d9-55615b6a1ce6",
  "domainName": "dev3.healthelife-appointment-type-service.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /appointment-type-configs/{id}

Retrieves the HealtheLife appointment type configuration for a given appointment type configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the appointment type configuration.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single appointment type configuration.	PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypeConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Wellness Domain Organization Mapping

Wellness domain organization mappings link a Wellness domain to a Cerner Millennium organization.

Retrieve a List of Domain Organization Mappings


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/patient-portal-application/v1/wellness-domain-org-mappings', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "millenniumOrgId": "1101444",
      "domainName": "cernerdemo.wellness.us.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/portal-application/v1/wellness-domain-org-mappings/?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/portal-application/v1/wellness-domain-org-mappings/?offset=0&limit=20"
}

GET /wellness-domain-org-mappings

Retrieves a list of mappings for a Wellness domain or domains to a Cerner Millennium organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domainName	query	string	false	N/A	Filters the mappings to those associated with the specified Wellness application domain.	-
millenniumOrgId	query	string	false	N/A	Filters the mappings to those associated with the specified Cerner Millennium organization 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	WellnessDomainOrgMappings
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Domain Organization Mapping




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/patient-portal-application/v1/wellness-domain-org-mappings', headers: headers, body: {"millenniumOrgId":"1101444","domainName":"cernerdemo.wellness.us.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/wellness-domain-org-mappings \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"millenniumOrgId":"1101444","domainName":"cernerdemo.wellness.us.healtheintent.com"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "millenniumOrgId": "1101444",
  "domainName": "cernerdemo.wellness.us.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /wellness-domain-org-mappings

Creates a domain organization mapping.

Parameters

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

Response Statuses

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

Update a Domain Organization Mapping




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/patient-portal-application/v1/wellness-domain-org-mappings/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers, body: {"millenniumOrgId":"1101444","domainName":"cernerdemo.wellness.us.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/wellness-domain-org-mappings/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"millenniumOrgId":"1101444","domainName":"cernerdemo.wellness.us.healtheintent.com"}

PUT /wellness-domain-org-mappings/{id}

Updates a domain organization mapping with the given domain organization mapping ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the domain organization mapping.	-
body	body	putWellnessDomainOrgMappings	true	N/A	No description	-

Response Statuses

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

Delete a Domain Organization Mapping


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/patient-portal-application/v1/wellness-domain-org-mappings/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/wellness-domain-org-mappings/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /wellness-domain-org-mappings/{id}

Deletes the domain organization mapping with the given domain organization mapping ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the domain organization mapping.	-

Response Statuses

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

Retrieve a Single Domain Organization Mapping


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/patient-portal-application/v1/wellness-domain-org-mappings/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/wellness-domain-org-mappings/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "millenniumOrgId": "1101444",
  "domainName": "cernerdemo.wellness.us.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /wellness-domain-org-mappings/{id}

Retrieves the domain organization mapping with the given domain organization mapping ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the domain organization mapping.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single domain organization mapping	PatientPortalApplicationPublicApi_Entities_V1_WellnessDomainOrgMapping
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Activity Logs

Activity logs record the actions performed by users on a patient record.

Retrieve a List of HealtheLife Activity Logs


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs',
  query: {
  'applicationExperienceDomain' => 'string',
'patientPortalPersonId' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs?applicationExperienceDomain=type,string&patientPortalPersonId=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "patientPortalPersonId": "801930",
      "personIdentifier": "10000143",
      "identifierType": "MRN",
      "featureDetail": "Blood Culture 2020-07-13 12:39:18.pdf",
      "applicationExperienceDomain": "dev3.healthelife-activity-log-service.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "featureDisplay": "Allergies",
      "actionDisplay": "Viewed",
      "actionByName": {
        "formatted": "Jones, Bob",
        "first": "Bob",
        "last": "Jones"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1//activity-logs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1//activity-logs?offset=0&limit=20"
}

GET /activity-logs

Retrieves a list of all HealtheLife activity logs that is paginated for the specified domain and person.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale for the action performed and the feature name in the patient portal application.	-
applicationExperienceDomain	query	string	true	N/A	The domain name of the tenant in the patient portal application to which the activity logs belong.	-
patientPortalPersonId	query	string	true	N/A	The Cerner Millennium ID of the patient in the patient portal application on whose EHR the actions were performed and logged.	-
lookBackMonths	query	integer(int32)	false	3	Filters the activity logs to only those from the number of specified look-back months forward.	-
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	25	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	A collection of activity logs.	GetActivityLogs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Activity Log




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/patient-portal-application/v1/activity-logs', headers: headers, body: {"patientPortalPersonId":"801930","personIdentifier":"10000252","identifierType":"MRN","feature":"ALLERGIES","featureDetail":"Blood Culture 2020-07-13 12:39:18.pdf","action":"VIEWED","actionBy":"urn:cerner:identity-federation:realm:ac193c1a-9763-45e1-9fa2-c1c3aa4ba16d:principal:bjones","applicationExperienceDomain":"dev3.healthelife-activity-log-service.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"patientPortalPersonId":"801930","personIdentifier":"10000252","identifierType":"MRN","feature":"ALLERGIES","featureDetail":"Blood Culture 2020-07-13 12:39:18.pdf","action":"VIEWED","actionBy":"urn:cerner:identity-federation:realm:ac193c1a-9763-45e1-9fa2-c1c3aa4ba16d:principal:bjones","applicationExperienceDomain":"dev3.healthelife-activity-log-service.com"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "patientPortalPersonId": "801930",
  "personIdentifier": "10000143",
  "identifierType": "MRN",
  "featureDetail": "Blood Culture 2020-07-13 12:39:18.pdf",
  "applicationExperienceDomain": "dev3.healthelife-activity-log-service.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "feature": "ALLERGIES",
  "action": "VIEWED",
  "actionBy": "urn:cerner:identity-federation:realm:ac193c1a-9763-45e1-9fa2-c1c3aa4ba16d:principal:bjones"
}

POST /activity-logs

Creates a HealtheLife activity log for the provided domain and person.

Parameters

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

Response Statuses

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

Delete a HealtheLife Activity Log


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/patient-portal-application/v1/activity-logs/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /activity-logs/{id}

Deletes the HealtheLife activity log with the given activity log ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the activity log.	-

Response Statuses

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

Appointment Notification Record

This endpoint is accessed by a Cerner Millennium operations job and provides the functionality to send a video visit appointment URL in a text message to patients.

Create an Appointment Notification Record




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/patient-portal-application/v1/appointment-notification-records', headers: headers, body: {"patient":{"id":"0727736243092149","name":"John Doe","phoneNumbers":[{"type":"PERSONAL","number":"1234567890","priority":1}]},"provider":{"id":"5047069076338414"},"visit":{"id":"3728638893545894","startDateTime":"2020-08-03T06:10:25.843Z","duration":30,"language":"EN"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-notification-records \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"patient":{"id":"0727736243092149","name":"John Doe","phoneNumbers":[{"type":"PERSONAL","number":"1234567890","priority":1}]},"provider":{"id":"5047069076338414"},"visit":{"id":"3728638893545894","startDateTime":"2020-08-03T06:10:25.843Z","duration":30,"language":"EN"}}

{
  "id": "97b5a802-1447-4f97-af02-7547ac0fc00b",
  "patient": {
    "id": "0727736243092149",
    "name": "John Doe",
    "phoneNumbers": [
      "1234567880"
    ]
  },
  "providerId": "5047069076338414",
  "visit": {
    "id": "3728638893545894",
    "startDateTime": "2020-08-03T06:10:25.843Z",
    "duration": 30,
    "locale": "en-US"
  }
}

POST /appointment-notification-records

Creates an appointment notification record.

Parameters

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

Response Statuses

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

Response Headers

Status	Header	Type	Format	Description
201	Location	string		The location of the newly created appointment notification record.

Activity Logs Configurations

Activity logs configurations allow tenants to configure the following items:

Policy text: Policy texts allow tenants to add the policies/ disclaimer/ important information related to the records or the list displayed to the consumer in the specific language and locale.
Policy text configuration: Policy text configurations allow tenants to configure the domain for the policy text so that the policy text is displayed in that domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.

Retrieve a List of Policy Texts


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/patient-portal-application/v1/activity-logs/policy-texts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-texts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-texts?offset=0&limit=20"
}

GET /activity-logs/policy-texts

Retrieves a list of policy texts for activity logs.

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	A collection of policy texts.	PolicyTexts
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Policy Text




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/patient-portal-application/v1/activity-logs/policy-texts', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

POST /activity-logs/policy-texts

Creates a policy text for activity logs.

Parameters

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

Response Statuses

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

Delete a Policy Text


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/patient-portal-application/v1/activity-logs/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /activity-logs/policy-texts/{id}

Deletes a policy text with the given policy text ID. If the policy text is associated with a policy text configuration, it cannot be deleted. If you want to delete a policy text that is associated with a configuration, you must first remove the associated configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text.	-

Response Statuses

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

Retrieve a Single Policy Text


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/patient-portal-application/v1/activity-logs/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

GET /activity-logs/policy-texts/{id}

Retrieves a single policy text for activity logs.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy test.	PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_PolicyText
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "policyText": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeTexts": [
          {
            "locale": "en-US",
            "text": "Sample Policy Text."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations?offset=0&limit=20"
}

GET /activity-logs/policy-text-configurations

Retrieves a list of policy text configurations for activity logs that is paginated per the specified parameters. The response can also be filtered by the domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of policy text configurations.	GetPolicyTextConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Activity Logs Policy Text




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/patient-portal-application/v1/activity-logs/policy-text-configurations', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyTextId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /activity-logs/policy-text-configurations

Creates a policy text configuration for activity logs.

Parameters

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

Response Statuses

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

Delete a Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /activity-logs/policy-text-configurations/{id}

Deletes a policy text configuration for activity logs.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-

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 Policy Text 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/patient-portal-application/v1/activity-logs/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /activity-logs/policy-text-configurations/{id}

Updates a policy text configuration for activity logs. The application experience domain cannot be updated; only the policy text ID in the configuration is updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
body	body	putActivityLogsPolicyTextConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyText": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeTexts": [
      {
        "locale": "en-US",
        "text": "Sample Policy Text."
      }
    ]
  }
}

GET /activity-logs/policy-text-configurations/{id}

Retrieves a single policy text configuration for activity logs.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text.	PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_GetPolicyTextConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Scheduling Configurations

Scheduling configurations allow tenants to configure the following items:

Policy text definition: Policy text definitions allow tenants to add policies, disclaimers, or other important information related to either the records or to the list that is displayed to the consumer in the specified language and locale.
Policy text configuration: Policy text configurations allow tenants to configure a domain for a policy text definition so that the policy text is displayed in that domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.

Retrieve a List of Scheduling Policy Text 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/patient-portal-application/v1/scheduling-policy-text-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "policyTexts": [
        {
          "policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ],
      "createdAt": "2020-08-03T06:10:25.843Z",
      "updatedAt": "2020-08-03T06:10:25.843Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions?offset=0&limit=20"
}

GET /scheduling-policy-text-definitions

Retrieves a list of policy text definitions for scheduling.

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	A collection of policy texts definitions.	PolicyTextDefinitions
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Scheduling Policy Text 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/patient-portal-application/v1/scheduling-policy-text-definitions', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "policyTexts": [
    {
      "policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-08-03T06:10:25.843Z",
  "updatedAt": "2020-08-03T06:10:25.843Z"
}

POST /scheduling-policy-text-definitions

Creates a policy text definition for scheduling.

Parameters

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

Response Statuses

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

Delete a Scheduling Policy Text 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/patient-portal-application/v1/scheduling-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /scheduling-policy-text-definitions/{id}

Deletes the scheduling policy text definition with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text definition.	-

Response Statuses

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

Retrieve a Single Scheduling Policy Text 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/patient-portal-application/v1/scheduling-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "policyTexts": [
    {
      "policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-08-03T06:10:25.843Z",
  "updatedAt": "2020-08-03T06:10:25.843Z"
}

GET /scheduling-policy-text-definitions/{id}

Retrieve a single policy text definition for scheduling.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text definition.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text definition	PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyTextDefinition
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Scheduling Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "policyTextDefinition": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "policyTexts": [
          {
            "policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
            "locale": "en-US",
            "text": "Sample Policy Text."
          }
        ]
      },
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-08-03T06:10:25.843Z",
      "updatedAt": "2020-08-03T06:10:25.843Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations?offset=0&limit=20"
}

GET /scheduling-policy-text-configurations

Retrieves a list of policy text configurations for scheduling.

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.	-
Accept-Language	header	string	false	en-US	The locale of the policy text definitions.	-
applicationExperienceDomain	query	string	false	N/A	The domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of policy text configurations.	PolicyTextConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Scheduling Policy Text 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/patient-portal-application/v1/scheduling-policy-text-configurations', headers: headers, body: {"policyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "policyTextDefinition": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "policyTexts": [
      {
        "policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
        "locale": "en-US",
        "text": "Sample Policy Text."
      }
    ]
  },
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-08-03T06:10:25.843Z",
  "updatedAt": "2020-08-03T06:10:25.843Z"
}

POST /scheduling-policy-text-configurations

Creates a policy text configuration for scheduling.

Parameters

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

Response Statuses

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

Delete a Scheduling Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /scheduling-policy-text-configurations/{id}

Deletes the policy text configuration with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-

Response Statuses

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

Update a Scheduling Policy Text 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/patient-portal-application/v1/scheduling-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /scheduling-policy-text-configurations/{id}

Updates a policy text configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
body	body	putSchedulingPolicyTextConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Scheduling Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "policyTextDefinition": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "policyTexts": [
      {
        "policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
        "locale": "en-US",
        "text": "Sample Policy Text."
      }
    ]
  },
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-08-03T06:10:25.843Z",
  "updatedAt": "2020-08-03T06:10:25.843Z"
}

GET /scheduling-policy-text-configurations/{id}

Retrieves a single policy text configuration for scheduling.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
Accept-Language	header	string	false	en-US	The locale of the policy text definitions.	-
applicationExperienceDomain	query	string	false	N/A	The domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text configuration	PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyTextConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Scheduling Feature Configurations

The scheduling feature configurations allow tenants to configure the following items:

Feature definition: Feature definitions allow tenants to configure various features and other scheduling configurations.
Feature configuration: Feature configurations allow tenants to configure a domain for a feature definition so that the feature definition is displayed in that domain.

Retrieve a List of Scheduling Feature 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/patient-portal-application/v1/scheduling-feature-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "cancellationDeadline": 3,
      "directBookAppointmentDelay": 3,
      "videoVisitVendor": "AMWELL",
      "appointmentBookingThreshold": 3,
      "directBookContactViaPhoneEnabled": true,
      "directBookContactViaMessageEnabled": true,
      "npaPortalAccountMinAge": 4,
      "npaSsnAliasPoolCode": 2,
      "facilityOrganizationId": "12345",
      "domain": "devengchsaml.patientportal.devhealtheintent.com",
      "legacyRequestWorkflowsEnabled": true,
      "createdAt": "2020-08-03T06:10:25.843Z",
      "updatedAt": "2020-08-03T06:10:25.843Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-definitions?offset=0&limit=20"
}

GET /scheduling-feature-definitions

Retrieves a list of feature definitions for scheduling.

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	A collection of feature definitions.	FeatureDefinitions
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Scheduling Feature 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/patient-portal-application/v1/scheduling-feature-definitions',
  query: {
  'applicationExperienceDomain' => 'string'
}, headers: headers, body: {"videoVisitVendor":"AMWELL","cancellationDeadline":2,"appointmentBookingThreshold":2,"requestSchedulingViaMessageEnabled":true,"requestSchedulingViaQueueEnabled":true,"directBookEnabled":true,"useLegacyDirectBook":true,"guidedSchedulingEnabled":true,"geoLocationEnabled":true,"requestCancelViaMessageEnabled":true,"directBookAppointmentDelay":2,"requestRescheduleEnabled":true,"directCancelEnabled":true,"directRescheduleEnabled":true,"npaAuthUsersEnabled":true,"npaUnauthUsersEnabled":true,"npaPortalAccountEnabled":true,"npaSsnEnabled":true,"directBookContactViaPhoneEnabled":true,"directBookContactViaMessageEnabled":true,"npaPortalAccountMinAge":2,"npaSsnAliasPoolCode":12,"facilityOrganizationId":"f69fa3dd-0000-494b-1111-4640ddd081e8","npaRequestSchedulingEnabled":true,"clipboardsEnabled":true,"domain":"cernerdemo.patientportal.us.healtheintent.com","videoVisitsEnabled":true,"amwellAppId":"18faf709-9a7d-4111-b7b1-97e0a53c34aa","legacyRequestWorkflowsEnabled":true,"bookByProviderEnabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-definitions?applicationExperienceDomain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"videoVisitVendor":"AMWELL","cancellationDeadline":2,"appointmentBookingThreshold":2,"requestSchedulingViaMessageEnabled":true,"requestSchedulingViaQueueEnabled":true,"directBookEnabled":true,"useLegacyDirectBook":true,"guidedSchedulingEnabled":true,"geoLocationEnabled":true,"requestCancelViaMessageEnabled":true,"directBookAppointmentDelay":2,"requestRescheduleEnabled":true,"directCancelEnabled":true,"directRescheduleEnabled":true,"npaAuthUsersEnabled":true,"npaUnauthUsersEnabled":true,"npaPortalAccountEnabled":true,"npaSsnEnabled":true,"directBookContactViaPhoneEnabled":true,"directBookContactViaMessageEnabled":true,"npaPortalAccountMinAge":2,"npaSsnAliasPoolCode":12,"facilityOrganizationId":"f69fa3dd-0000-494b-1111-4640ddd081e8","npaRequestSchedulingEnabled":true,"clipboardsEnabled":true,"domain":"cernerdemo.patientportal.us.healtheintent.com","videoVisitsEnabled":true,"amwellAppId":"18faf709-9a7d-4111-b7b1-97e0a53c34aa","legacyRequestWorkflowsEnabled":true,"bookByProviderEnabled":true}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "cancellationDeadline": 3,
  "directBookAppointmentDelay": 3,
  "videoVisitVendor": "AMWELL",
  "appointmentBookingThreshold": 3,
  "directBookContactViaPhoneEnabled": true,
  "directBookContactViaMessageEnabled": true,
  "npaPortalAccountMinAge": 4,
  "npaSsnAliasPoolCode": 2,
  "facilityOrganizationId": "12345",
  "domain": "devengchsaml.patientportal.devhealtheintent.com",
  "legacyRequestWorkflowsEnabled": true,
  "createdAt": "2020-08-03T06:10:25.843Z",
  "updatedAt": "2020-08-03T06:10:25.843Z"
}

POST /scheduling-feature-definitions

Creates a feature definition for scheduling.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	true	N/A	The domain name of a tenant in the patient portal application that uses the scheduling config service.	-
body	body	postSchedulingFeatureDefinitions	true	N/A	No description	-

Response Statuses

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

Delete a Scheduling Feature 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/patient-portal-application/v1/scheduling-feature-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /scheduling-feature-definitions/{id}

Deletes the feature definition with the specified ID.

Parameters

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

Response Statuses

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

Retrieve a List of Scheduling Feature 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/patient-portal-application/v1/scheduling-feature-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "featureDefinition": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "cancellationDeadline": 3,
        "directBookEnabled": false,
        "useLegacyDirectBook": false,
        "guidedSchedulingEnabled": false,
        "requestSchedulingViaQueueEnabled": false,
        "directBookAppointmentDelay": 3,
        "requestRescheduleEnabled": false,
        "geoLocationEnabled": false,
        "videoVisitVendor": "AMWELL",
        "requestCancelViaMessageEnabled": false,
        "appointmentBookingThreshold": 3,
        "requestSchedulingViaMessageEnabled": false,
        "directCancelEnabled": false,
        "directRescheduleEnabled": false,
        "npaAuthUsersEnabled": false,
        "npaUnauthUsersEnabled": false,
        "npaPortalAccountEnabled": false,
        "npaSsnEnabled": false,
        "directBookContactViaPhoneEnabled": true,
        "directBookContactViaMessageEnabled": true,
        "npaPortalAccountMinAge": 4,
        "npaSsnAliasPoolCode": 2,
        "facilityOrganizationId": "12345",
        "npaRequestSchedulingEnabled": false,
        "clipboardsEnabled": false,
        "domain": "devengchsaml.patientportal.devhealtheintent.com",
        "videoVisitsEnabled": false,
        "amwellAppId": null,
        "legacyRequestWorkflowsEnabled": true,
        "bookByProviderEnabled": false
      },
      "createdAt": "2020-08-03T06:10:25.843Z",
      "updatedAt": "2020-08-03T06:10:25.843Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations?offset=0&limit=20"
}

GET /scheduling-feature-configurations

Retrieves a list of feature configurations for scheduling.

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	A collection of feature configurations.	FeatureConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Scheduling Feature 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/patient-portal-application/v1/scheduling-feature-configurations', headers: headers, body: {"featureDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"featureDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "featureDefinition": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "cancellationDeadline": 3,
    "directBookEnabled": false,
    "useLegacyDirectBook": false,
    "guidedSchedulingEnabled": false,
    "requestSchedulingViaQueueEnabled": false,
    "directBookAppointmentDelay": 3,
    "requestRescheduleEnabled": false,
    "geoLocationEnabled": false,
    "videoVisitVendor": "AMWELL",
    "requestCancelViaMessageEnabled": false,
    "appointmentBookingThreshold": 3,
    "requestSchedulingViaMessageEnabled": false,
    "directCancelEnabled": false,
    "directRescheduleEnabled": false,
    "npaAuthUsersEnabled": false,
    "npaUnauthUsersEnabled": false,
    "npaPortalAccountEnabled": false,
    "npaSsnEnabled": false,
    "directBookContactViaPhoneEnabled": true,
    "directBookContactViaMessageEnabled": true,
    "npaPortalAccountMinAge": 4,
    "npaSsnAliasPoolCode": 2,
    "facilityOrganizationId": "12345",
    "npaRequestSchedulingEnabled": false,
    "clipboardsEnabled": false,
    "domain": "devengchsaml.patientportal.devhealtheintent.com",
    "videoVisitsEnabled": false,
    "amwellAppId": null,
    "legacyRequestWorkflowsEnabled": true,
    "bookByProviderEnabled": false
  },
  "createdAt": "2020-08-03T06:10:25.843Z",
  "updatedAt": "2020-08-03T06:10:25.843Z"
}

POST /scheduling-feature-configurations

Creates a feature configuration for scheduling.

Parameters

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

Response Statuses

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

Delete a Scheduling Feature Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /scheduling-feature-configurations/{id}

Deletes the feature configuration with the specified ID.

Parameters

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

Response Statuses

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

Update a Scheduling Feature 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/patient-portal-application/v1/scheduling-feature-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"featureDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"featureDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}

PUT /scheduling-feature-configurations/{id}

Updates a feature configuration for scheduling.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the feature configuration.	-
body	body	putSchedulingFeatureConfigurations	true	N/A	No description	-

Response Statuses

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

Allergies Policy Text Configuration

The allergies policy text configuration endpoints enable tenants to configure the following items:

Policy Texts: Allergies policy texts enable adding the policies, disclaimer, and other important information related to the allergy records that are displayed to the consumer in the specific language and locale. This allows tenants to create only one policy text for a locale. The locale is the language code, for example, en-US.
Policy Text Configurations: Policy text configurations enable configuration of application experience domains for policy texts. This includes storing, updating, and deleting the policy text’s association with the application experience domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.

Retrieve a List of Policy Texts


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/patient-portal-application/v1/allergies/policy-texts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-texts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-texts?offset=0&limit=20"
}

GET /allergies/policy-texts

Retrieves a list of policy texts for allergies.

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	A collection of policy texts.	PolicyTexts
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Policy Text




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/patient-portal-application/v1/allergies/policy-texts', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

POST /allergies/policy-texts

Creates a policy text for allergies.

Parameters

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

Response Statuses

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

Delete a Policy Text


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/patient-portal-application/v1/allergies/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /allergies/policy-texts/{id}

Deletes the policy text with the given policy text ID. If the policy text is associated with a policy text configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text.	-

Response Statuses

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

Retrieve a Single Policy Text


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/patient-portal-application/v1/allergies/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

GET /allergies/policy-texts/{id}

Retrieves a single policy text for allergies.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_PolicyText
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "policyText": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeTexts": [
          {
            "locale": "en-US",
            "text": "Sample Policy Text."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations?offset=0&limit=20"
}

GET /allergies/policy-text-configurations

Retrieves a list of policy text configurations for allergies that is paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of policy texts.	GetPolicyTextConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Allergies Policy Text 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/patient-portal-application/v1/allergies/policy-text-configurations', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyTextId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /allergies/policy-text-configurations

Creates a policy text configuration for allergies.

Parameters

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

Response Statuses

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

Delete a Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /allergies/policy-text-configurations/{id}

Deletes a policy text configuration for allergies.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-

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 Policy Text 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/patient-portal-application/v1/allergies/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /allergies/policy-text-configurations/{id}

Updates a policy text configuration for allergies. Only the policy text ID can be updated. The application experience domain cannot be.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
body	body	putAllergiesPolicyTextConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyText": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeTexts": [
      {
        "locale": "en-US",
        "text": "Sample Policy Text."
      }
    ]
  }
}

GET /allergies/policy-text-configurations/{id}

Retrieves a single policy text configuration for allergies.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy test.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_GetPolicyTextConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Allergies Knowledge Base Configuration

The allergies knowledge base configuration endpoints enable tenants to configure the following items:

Knowledge Bases: Knowledge bases enable the addition of the facility from which the request is made to provide education about allergies. This also allows tenants to add primary search criteria to determine the education information relevant to a specific allergy and the locale to determine the language in which searching is performed.
Knowledge Base Configurations: Knowledge base configurations enable configuring application experience domains for the knowledge base. This includes storing, updating, and deleting the knowledge base’s association with the application experience domain. One knowledge base can be associated with multiple application experience domains, but one domain cannot be associated with multiple knowledge bases.

Retrieve a List of Knowledge Bases


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/patient-portal-application/v1/allergies/knowledge-bases', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-bases \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeCodes": [
        {
          "locale": "en-US",
          "code": "151"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-bases?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-bases?offset=0&limit=20"
}

GET /allergies/knowledge-bases

Retrieves a list of knowledge bases for allergies.

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	A collection of knowledge bases.	KnowledgeBases
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Knowledge Base




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/patient-portal-application/v1/allergies/knowledge-bases', headers: headers, body: {"localeCodes":[{"locale":"en-US","code":"151"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-bases \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeCodes":[{"locale":"en-US","code":"151"}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeCodes": [
    {
      "locale": "en-US",
      "code": "151"
    }
  ]
}

POST /allergies/knowledge-bases

Creates a knowledge base for allergies.

Parameters

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

Response Statuses

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

Delete a Knowledge Base


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/patient-portal-application/v1/allergies/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /allergies/knowledge-bases/{id}

Deletes a knowledge base with the given knowledge base ID. If the knowledge base is associated with a knowledge base configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base.	-

Response Statuses

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

Retrieve a Single Knowledge Base


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/patient-portal-application/v1/allergies/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeCodes": [
    {
      "locale": "en-US",
      "code": "151"
    }
  ]
}

GET /allergies/knowledge-bases/{id}

Retrieves a single knowledge base for allergies.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single knowledge base.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_KnowledgeBase
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-base-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-base-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "knowledgeBase": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "facilityCd": "151",
        "primaryCriteriaCd": "123",
        "localeCodes": [
          {
            "locale": "en-US",
            "code": "151"
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/policy-text-configurations?offset=0&limit=20"
}

GET /allergies/knowledge-base-configurations

Retrieves a list of policy text configurations for allergies that is paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of policy texts.	GetKnowledgeBaseConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create Allergies Knowledge Base




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/patient-portal-application/v1/allergies/knowledge-base-configurations', headers: headers, body: {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-base-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "knowledgeBaseId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /allergies/knowledge-base-configurations

Creates a knowledge base configuration for allergies.

Parameters

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

Response Statuses

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

Delete a Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /allergies/knowledge-base-configurations/{id}

Deletes a policy text configuration for allergies.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base configuration.	-

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 Policy Text 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/patient-portal-application/v1/allergies/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /allergies/knowledge-base-configurations/{id}

Updates a policy text configuration for allergies. Only the policy text ID can be updated. The application experience domain cannot be.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base configuration.	-
body	body	putAllergiesKnowledgeBaseConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-base-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/knowledge-base-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "knowledgeBase": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "facilityCd": "151",
    "primaryCriteriaCd": "123",
    "localeCodes": [
      {
        "locale": "en-US",
        "code": "151"
      }
    ]
  }
}

GET /allergies/knowledge-base-configurations/{id}

Retrieves a single policy text configuration for allergies.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base configuration.	-
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy test.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_GetKnowledgeBaseConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Allergies Comments Configurations

Comments related to a person’s allergy record can be configured by enabling or disabling the comments configuration for an application experience domain. You can also delete the comments configuration if it is no longer required.

Retrieve a List of HealtheLife Allergies Comments 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/patient-portal-application/v1/allergies/comments-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "enabled": "true",
      "applicationExperienceDomain": "testapp.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations?offset=0&limit=20"
}

GET /allergies/comments-configurations

Retrieves a list of all the HealtheLife allergies comments configurations that are paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife comments configurations belong.	-
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	A collection of comment configurations.	CommentsConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Comments 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/patient-portal-application/v1/allergies/comments-configurations', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "enabled": "true",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /allergies/comments-configurations

Creates a HealtheLife comments configuration by associating the domain with the given comments configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The comments configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_CommentsConfiguration
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Allergies Comments Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /allergies/comments-configurations/{id}

Deletes the HealtheLife allergies comments configuration with the given comments configuration ID.

Parameters

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

Response Statuses

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

Update a HealtheLife Allergies Comments 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/patient-portal-application/v1/allergies/comments-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /allergies/comments-configurations/{id}

Updates the HealtheLife allergies comments configuration with the given comment configuration ID. The domain cannot be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the comment configuration.	-
body	body	putAllergiesCommentsConfigurations	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

Retrieve a Single HealtheLife Allergies Comments 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/patient-portal-application/v1/allergies/comments-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "enabled": "true",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /allergies/comments-configurations/{id}

Retrieves the HealtheLife allergies comments configuration with the given comment configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single comments configuration.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_CommentsConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Allergies Adolescent Data Flag Configuration

The Allergies Adolescent Data Flag Configuration endpoints enable tenants to configure the adolescent data flag for an application experience domain. This configuration includes storing, updating, and deleting the adolescent data flag configuration associated with the application experience domain. One adolescent data flag configuration can be associated with one application experience domain.

Retrieve a List of HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/allergies/adolescent-data-flag-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "testapp.com",
      "enabled": "true",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations?offset=0&limit=20"
}

GET /allergies/adolescent-data-flag-configurations

Retrieves a list of all the HealtheLife adolescent data flag configurations that are paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife adolescent data flag configurations belong.	-
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	A collection of comment configurations.	AdolescentDataFlagConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/allergies/adolescent-data-flag-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "enabled": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /allergies/adolescent-data-flag-configurations

Creates a HealtheLife adolescent data flag configuration by associating the domain with the given adolescent data flag configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The adolescent data flag configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_AdolescentDataFlagConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Adolescent Data Flag Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Deletes the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-

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 HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}

PUT /allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Updates the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID. The domain cannot be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-
body	body	putAllergiesAdolescentDataFlagConfigurations	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 HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "enabled": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Retrieves the HealtheLife allergies adolescent data flag configuration with the given adolescent data flag configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single adolescent data flag configuration.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_AdolescentDataFlagConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Allergies Infobutton Configurations

Allergies Infobutton configurations enable tenants to configure an Infobutton for an application experience domain. You can configure this button with a URL to a page that provides more information.

Retrieve a List of HealtheLife Allergies Infobutton 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/patient-portal-application/v1/allergies/info-button-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/info-button-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "educationContentUrl": "https://allergies.learnmore.com",
      "applicationExperienceDomain": "testapp.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/info-button-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/info-button-configurations?offset=0&limit=20"
}

GET /allergies/info-button-configurations

Retrieves a list of all the HealtheLife allergies Infobutton configurations that are paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife Infobutton configurations belong.	-
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	A collection of Infobutton configurations.	InfoButtonConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Allergies Infobutton 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/patient-portal-application/v1/allergies/info-button-configurations', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/info-button-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "educationContentUrl": "https://allergies.learnmore.com",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /allergies/info-button-configurations

Creates a HealtheLife Infobutton configuration by associating the domain with the given Infobutton configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The Infobutton configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_InfoButtonConfiguration
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Allergies Infobutton Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /allergies/info-button-configurations/{id}

Deletes the HealtheLife allergies Infobutton configuration with the given Infobutton configuration ID.

Parameters

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

Response Statuses

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

Update a HealtheLife Allergies Infobutton 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/patient-portal-application/v1/allergies/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /allergies/info-button-configurations/{id}

Updates the HealtheLife allergies Infobutton configuration with the given Infobutton configuration ID. You cannot update the domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the Infobutton configuration.	-
body	body	putAllergiesInfoButtonConfigurations	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

Retrieve a Single HealtheLife Allergies Infobutton 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/patient-portal-application/v1/allergies/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "educationContentUrl": "https://allergies.learnmore.com",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /allergies/info-button-configurations/{id}

Retrieves the HealtheLife allergies Infobutton configuration with the given Infobutton configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	An Infobutton configuration.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_InfoButtonConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Immunizations Infobutton Configurations

Immunizations Infobutton configurations enable tenants to configure an Infobutton for an application experience domain. You can configure this button with a URL to a page that provides more information.

Retrieve a List of HealtheLife Immunizations Infobutton 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/patient-portal-application/v1/immunizations/info-button-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/info-button-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "educationContentUrl": "https://immunizations.learnmore.com",
      "applicationExperienceDomain": "testapp.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/info-button-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/info-button-configurations?offset=0&limit=20"
}

GET /immunizations/info-button-configurations

Retrieves a list of all the HealtheLife immunizations Infobutton configurations that is paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife Infobutton configurations belong.	-
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	A collection of Infobutton configurations.	InfoButtonConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Immunizations Infobutton 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/patient-portal-application/v1/immunizations/info-button-configurations', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/info-button-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "educationContentUrl": "https://immunizations.learnmore.com",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /immunizations/info-button-configurations

Creates a HealtheLife immunizations Infobutton configuration by associating the domain with the given Infobutton configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The Infobutton configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_InfoButtonConfiguration
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Immunizations Infobutton Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/info-button-configurations/{id}

Deletes the HealtheLife immunizations Infobutton configuration with the given Infobutton configuration ID.

Parameters

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

Response Statuses

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

Update a HealtheLife Immunizations Infobutton 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/patient-portal-application/v1/immunizations/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /immunizations/info-button-configurations/{id}

Updates the HealtheLife immunizations Infobutton configuration with the given Infobutton configuration ID. You cannot update the domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the Infobutton configuration.	-
body	body	putImmunizationsInfoButtonConfigurations	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

Retrieve a Single HealtheLife Immunizations Infobutton 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/patient-portal-application/v1/immunizations/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/info-button-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "educationContentUrl": "https://immunizations.learnmore.com",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /immunizations/info-button-configurations/{id}

Retrieves the HealtheLife immunizations Infobutton configuration with the given Infobutton configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	An Infobutton configuration.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_InfoButtonConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Allergies Configurations

The allergies configurations endpoint enables the retrieval of all of the configurations for allergies for the specified application experience domain at the same time.

Retrieve a List of Allergies Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/configurations',
  query: {
  'applicationExperienceDomain' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/configurations?applicationExperienceDomain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "policyTextConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "policyText": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "localeTexts": [
            {
              "locale": "en-US",
              "text": "Sample Policy Text."
            }
          ]
        }
      },
      "knowledgeBaseConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "knowledgeBase": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "facilityCd": "151",
          "primaryCriteriaCd": "123",
          "localeCodes": [
            {
              "locale": "en-US",
              "code": "151"
            }
          ]
        }
      },
      "commentsConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "enabled": "true",
        "applicationExperienceDomain": "testapp.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      },
      "dataSourceConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "dataSource": "HEALTHEINTENT",
        "applicationExperienceDomain": "testapp.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      },
      "adolescentDataFlagConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "testapp.com",
        "enabled": "true",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      },
      "infoButtonConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "educationContentUrl": "https://allergies.learnmore.com",
        "applicationExperienceDomain": "testapp.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/configurations?offset=0&limit=20"
}

GET /allergies/configurations

Retrieves a list of all the configurations for allergies that is paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the configuration.	-
applicationExperienceDomain	query	string	true	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of policy texts.	Configurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Immunizations Policy Text Configuration

The Immunizations Policy Text Configuration endpoints enable tenants to configure the following items:

Policy Texts: Immunizations policy texts enable adding the policies, disclaimer, and other important information related to the allergy records that are displayed to the consumer in the specific language and locale. This allows tenants to create only one policy text for a locale. The locale is the language code, for example, en-US.
Policy Text Configurations: Policy text configurations enable configuring application experience domains for policy texts. This includes storing, updating, and deleting the policy text’s association with the application experience domain. Associating the policy text with the domain allows the text to be displayed in that domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.

Retrieve a List of Policy Texts


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/patient-portal-application/v1/immunizations/policy-texts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-texts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-texts?offset=0&limit=20"
}

GET /immunizations/policy-texts

Retrieves a list of policy texts for immunizations.

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	A collection of policy texts.	PolicyTexts
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Policy Text




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/patient-portal-application/v1/immunizations/policy-texts', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

POST /immunizations/policy-texts

Creates a policy text for immunizations.

Parameters

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

Response Statuses

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

Delete a Policy Text


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/patient-portal-application/v1/immunizations/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/policy-texts/{id}

Deletes a policy text with the given policy text ID. If the address is associated with an address configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text.	-

Response Statuses

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

Retrieve a Single Policy Text


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/patient-portal-application/v1/immunizations/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

GET /immunizations/policy-texts/{id}

Retrieves a single policy text for immunizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_PolicyText
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "policyText": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeTexts": [
          {
            "locale": "en-US",
            "text": "Sample Policy Text."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations?offset=0&limit=20"
}

GET /immunizations/policy-text-configurations

Retrieves a list of policy text configurations for immunizations that is paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
applicationExperienceDomain	query	string	false	N/A	The ID of the tenant’s environment.	-
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	A collection of policy texts.	GetPolicyTextConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Immunizations Policy Text




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/patient-portal-application/v1/immunizations/policy-text-configurations', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyTextId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /immunizations/policy-text-configurations

Creates a policy text configuration for immunizations.

Parameters

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

Response Statuses

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

Delete a Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/policy-text-configurations/{id}

Deletes a policy text configuration for immunizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-

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 Policy Text 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/patient-portal-application/v1/immunizations/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /immunizations/policy-text-configurations/{id}

Updates a policy text configuration for immunizations. The domain cannot be updated. Only the ID can be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
body	body	putImmunizationsPolicyTextConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyText": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeTexts": [
      {
        "locale": "en-US",
        "text": "Sample Policy Text."
      }
    ]
  }
}

GET /immunizations/policy-text-configurations/{id}

Retrieves a single policy text configuration for immunizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the policy text configuration.	-
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
applicationExperienceDomain	query	string	false	N/A	The ID of the tenant’s environment.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetPolicyTextConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Immunizations Logo Configuration

The Immunizations Logo Configuration endpoints enable tenants to configure the following items:

Logo: Logos allow tenants to add the logo of the organization that is displayed on the page by specifying the URL. This is mainly used for the purpose of branding.
Logo Configuration: Logo configurations allow tenants to configure the application experience domain for the logo. This includes storing, updating, and deleting the logo’s association with the application experience domain. One logo can be associated with multiple application experience domains, but one domain cannot be associated with multiple logos.

Retrieve a List of Logos


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/patient-portal-application/v1/immunizations/logos', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "url": "http://www.cerner.com"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logos?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logos?offset=0&limit=20"
}

GET /immunizations/logos

Retrieves a list of logos for immunizations.

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	A collection of Logos.	Logos
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Logo




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/patient-portal-application/v1/immunizations/logos', headers: headers, body: {"url":"http://www.cerner.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logos \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"url":"http://www.cerner.com"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "url": "http://www.cerner.com"
}

POST /immunizations/logos

Creates a logo for immunizations.

Parameters

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

Response Statuses

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

Delete a Logo


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/patient-portal-application/v1/immunizations/logos/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logos/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/logos/{id}

Deletes a logo with the given logo ID. If the logo is associated with a logo configuration, it cannot be deleted.

Parameters

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

Response Statuses

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

Retrieve a Single Logo


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/patient-portal-application/v1/immunizations/logos/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logos/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "url": "http://www.cerner.com"
}

GET /immunizations/logos/{id}

Retrieves a single logo for immunizations.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Logo	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_Logo
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Logo 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/patient-portal-application/v1/immunizations/logo-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logo-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "logo": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "url": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logo-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logo-configurations?offset=0&limit=20"
}

GET /immunizations/logo-configurations

Retrieves a list of logo configurations for immunizations that is paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	The ID of the tenant’s environment.	-
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	A collection of logos.	GetLogoConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Immunizations Logo




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/patient-portal-application/v1/immunizations/logo-configurations', headers: headers, body: {"logoId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logo-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"logoId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "logoId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /immunizations/logo-configurations

Creates a logo configuration for immunizations.

Parameters

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

Response Statuses

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

Delete a Logo Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logo-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logo-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/logo-configurations/{id}

Deletes a logo configuration for immunizations.

Parameters

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

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 Logo 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/patient-portal-application/v1/immunizations/logo-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"logoId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logo-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"logoId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /immunizations/logo-configurations/{id}

Updates a logo configuration for immunizations. The domain cannot be updated. Only the ID can be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the logo configuration.	-
body	body	putImmunizationsLogoConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Logo 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/patient-portal-application/v1/immunizations/logo-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/logo-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "logo": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "url": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
  }
}

GET /immunizations/logo-configurations/{id}

Retrieves a single logo configuration for immunizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the logo configuration.	-
applicationExperienceDomain	query	string	false	N/A	The ID of the tenant’s environment.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single logo	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetLogoConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Immunizations Address Configuration

The Immunizations Address Configuration endpoints enable tenants to configure the following items:

Address: Addresses allow tenants to add the address of the organization that is displayed on the page in the specific language and locale. This is mainly used for the purpose of communication. This enables the creation of an address by specifying up to six lines that can include an address, phone number, email address, and so on as contact information. Only one address can be configured for a locale, and the locale is the language code, for example, en-US.
Address Configuration: Address configurations allow tenants to configure the application experience domain for the address. This includes storing, updating, and deleting the address’s association with the application experience domain. One address can be associated with multiple application experience domains, but one domain cannot be associated with multiple addresses.

Retrieve a List of Addresses


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/patient-portal-application/v1/immunizations/addresses', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeAddresses": [
        {
          "locale": "en-US",
          "line1": "Cerner",
          "line2": "H2 block",
          "line3": "B Wing",
          "line4": "Manyata Tech Park",
          "line5": "Bangalore",
          "line6": "India"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/addresses?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/addresses?offset=0&limit=20"
}

GET /immunizations/addresses

Retrieves a list of addresses for immunizations.

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	A collection of Addresses.	Addresses
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Address




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/patient-portal-application/v1/immunizations/addresses', headers: headers, body: {"localeAddresses":[{"locale":"en-US","line1":"Cerner","line2":"H2 block","line3":"B Wing","line4":"Manyata Tech Park","line5":"Bangalore","line6":"India"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/addresses \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeAddresses":[{"locale":"en-US","line1":"Cerner","line2":"H2 block","line3":"B Wing","line4":"Manyata Tech Park","line5":"Bangalore","line6":"India"}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeAddresses": [
    {
      "locale": "en-US",
      "line1": "Cerner",
      "line2": "H2 block",
      "line3": "B Wing",
      "line4": "Manyata Tech Park",
      "line5": "Bangalore",
      "line6": "India"
    }
  ]
}

POST /immunizations/addresses

Creates an address for immunizations.

Parameters

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

Response Statuses

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

Delete an Address


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/patient-portal-application/v1/immunizations/addresses/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/addresses/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/addresses/{id}

Deletes the address with the given address ID. If the address is associated with an address configuration, it cannot be deleted.

Parameters

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

Response Statuses

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

Retrieve a Single Address


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/patient-portal-application/v1/immunizations/addresses/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/addresses/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeAddresses": [
    {
      "locale": "en-US",
      "line1": "Cerner",
      "line2": "H2 block",
      "line3": "B Wing",
      "line4": "Manyata Tech Park",
      "line5": "Bangalore",
      "line6": "India"
    }
  ]
}

GET /immunizations/addresses/{id}

Retrieves a single address for immunizations.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single address.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_Address
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Address Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "address": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeAddresses": [
          {
            "locale": "en-US",
            "line1": "Cerner",
            "line2": "H2 block",
            "line3": "B Wing",
            "line4": "Manyata Tech Park",
            "line5": "Bangalore",
            "line6": "India"
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations?offset=0&limit=20"
}

GET /immunizations/address-configurations

Retrieves a list of address configurations for immunizations that is paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the address.	-
applicationExperienceDomain	query	string	false	N/A	The ID of the tenant’s environment.	-
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	A collection of Addresses.	GetAddressConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Immunizations Address




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/patient-portal-application/v1/immunizations/address-configurations', headers: headers, body: {"addressId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"addressId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "addressId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /immunizations/address-configurations

Creates an address configuration for immunizations.

Parameters

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

Response Statuses

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

Delete an Address Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/address-configurations/{id}

Deletes an address configuration for immunizations.

Parameters

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

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 Address 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/patient-portal-application/v1/immunizations/address-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"addressId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"addressId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /immunizations/address-configurations/{id}

Updates an address configuration for immunizations. The domain cannot be updated. Only the ID can be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the address configuration.	-
body	body	putImmunizationsAddressConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Address Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/address-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "address": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeAddresses": [
      {
        "locale": "en-US",
        "line1": "Cerner",
        "line2": "H2 block",
        "line3": "B Wing",
        "line4": "Manyata Tech Park",
        "line5": "Bangalore",
        "line6": "India"
      }
    ]
  }
}

GET /immunizations/address-configurations/{id}

Retrieves a single address configuration for immunizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the address configuration.	-
Accept-Language	header	string	false	en-US	The locale of the address.	-
applicationExperienceDomain	query	string	false	N/A	The ID of the tenant’s environment.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetAddressConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Immunizations Knowledge Base Configuration

The Knowledge Base Configuration endpoints enable tenants to configure the following items:

Knowledge Bases: Knowledge bases enable the addition of the facility from which the request is made to provide education about immunizations. This also allows tenants to add primary search criteria to determine the education information relevant to a specific immunization and the locale to determine the language in which searching is performed.
Knowledge Base Configurations: Knowledge base configurations enable the configuration of application experience domains for the knowledge base. This includes storing, updating, and deleting the knowledge base’s association with the application experience domain. One knowledge base can be associated with multiple application experience domains, but one domain cannot be associated with multiple knowledge bases.

Retrieve a List of Knowledge Bases


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/patient-portal-application/v1/immunizations/knowledge-bases', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-bases \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "facilityCd": "88389",
      "primaryCriteriaCd": "79995",
      "localeCodes": [
        {
          "locale": "en-US",
          "code": "65885."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-bases?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-bases?offset=0&limit=20"
}

GET /immunizations/knowledge-bases

Retrieves a list of knowledge bases for immunizations.

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	A collection of knowledge bases.	KnowledgeBases
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Knowledge Base




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/patient-portal-application/v1/immunizations/knowledge-bases', headers: headers, body: {"localeCodes":[{"locale":"en-US","code":"151"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-bases \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeCodes":[{"locale":"en-US","code":"151"}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "facilityCd": "88389",
  "primaryCriteriaCd": "79995",
  "localeCodes": [
    {
      "locale": "en-US",
      "code": "65885."
    }
  ]
}

POST /immunizations/knowledge-bases

Creates a knowledge base for immunizations.

Parameters

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

Response Statuses

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

Delete a Knowledge Base


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/patient-portal-application/v1/immunizations/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/knowledge-bases/{id}

Deletes a knowledge base with the given knowledge base ID. If the knowledge base is associated with a knowledge base configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base.	-

Response Statuses

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

Retrieve a Single Knowledge Base


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/patient-portal-application/v1/immunizations/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "facilityCd": "88389",
  "primaryCriteriaCd": "79995",
  "localeCodes": [
    {
      "locale": "en-US",
      "code": "65885."
    }
  ]
}

GET /immunizations/knowledge-bases/{id}

Retrieves a single knowledge base for immunizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single knowledge base.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_KnowledgeBase
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Knowledge Base Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "knowledgeBase": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "facilityCd": "88389",
        "primaryCriteriaCd": "79995",
        "localeCodes": [
          {
            "locale": "en-US",
            "code": "65885."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations?offset=0&limit=20"
}

GET /immunizations/knowledge-base-configurations

Retrieves a list of knowledge base configurations for immunizations that is paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the knowledge base.	-
applicationExperienceDomain	query	string	false	N/A	The ID of the tenant’s environment.	-
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	A collection of knowledge bases.	GetKnowledgeBaseConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Immunizations Knowledge Base




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/patient-portal-application/v1/immunizations/knowledge-base-configurations', headers: headers, body: {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "knowledgeBaseId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /immunizations/knowledge-base-configurations

Creates a knowledge base configuration for immunizations.

Parameters

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

Response Statuses

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

Delete a Knowledge Base Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/knowledge-base-configurations/{id}

Deletes a knowledge base configuration for immunizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base configuration.	-

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 Knowledge Base 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/patient-portal-application/v1/immunizations/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /immunizations/knowledge-base-configurations/{id}

Updates a knowledge base configuration for immunizations. The domain cannot be updated. Only the ID can be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base configuration.	-
body	body	putImmunizationsKnowledgeBaseConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Knowledge Base Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/knowledge-base-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "knowledgeBase": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "facilityCd": "88389",
    "primaryCriteriaCd": "79995",
    "localeCodes": [
      {
        "locale": "en-US",
        "code": "65885."
      }
    ]
  }
}

GET /immunizations/knowledge-base-configurations/{id}

Retrieves a single knowledge base configuration for immunizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base configuration.	-
Accept-Language	header	string	false	en-US	The locale of the knowledge base.	-
applicationExperienceDomain	query	string	false	N/A	The ID of the tenant’s environment.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single knowledge base.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetKnowledgeBaseConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Immunizations Data Source Configurations

Immunizations data source configurations allow you to select immunizations data from either Health Data Intelligence Longitudinal Record or Cerner Millennium for an application experience domain. You can also delete the configuration if it is no longer required.

Retrieve a List of HealtheLife Immunizations Data Source 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/patient-portal-application/v1/immunizations/data-source-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/data-source-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "dataSource": "HEALTHEINTENT",
      "applicationExperienceDomain": "testapp.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/data-source-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/data-source-configurations?offset=0&limit=20"
}

GET /immunizations/data-source-configurations

Retrieves a list of all the HealtheLife immunizations data source configurations that is paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife data source configurations belong.	-
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	A collection of data source configurations.	DataSourceConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Immunizations Data Source 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/patient-portal-application/v1/immunizations/data-source-configurations', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/data-source-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "dataSource": "HEALTHEINTENT",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /immunizations/data-source-configurations

Creates a HealtheLife immunizations data source configuration by associating the domain with the given data source configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The data source configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_DataSourceConfiguration
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Immunizations Data Source Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/data-source-configurations/{id}

Deletes the HealtheLife immunizations data source configuration with the given data source configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-

Response Statuses

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

Update a HealtheLife Immunizations Data Source 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/patient-portal-application/v1/immunizations/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /immunizations/data-source-configurations/{id}

Updates the HealtheLife immunizations data source configuration with the given data source configuration ID. You cannot update the domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-
body	body	putImmunizationsDataSourceConfigurations	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

Retrieve a Single HealtheLife Immunizations Data Source 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/patient-portal-application/v1/immunizations/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "dataSource": "HEALTHEINTENT",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /immunizations/data-source-configurations/{id}

Retrieves the HealtheLife immunizations data source configuration with the given data source configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A data source configuration.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_DataSourceConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Immunizations Adolescent Data Flag Configuration

The Immunizations Adolescent Data Flag Configuration endpoints enable tenants to configure the adolescent data flag for an application experience domain.This configuration includes storing, updating, and deleting the adolescent data flag configuration associated with the application experience domain. One adolescent data flag configuration can be associated with one application experience domain.

Retrieve a List of HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "testapp.com",
      "enabled": true,
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations?offset=0&limit=20"
}

GET /immunizations/adolescent-data-flag-configurations

Retrieves a list of all the HealtheLife adolescent data flag configurations that are paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife adolescent data flag configurations belong.	-
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	A collection of adolescent data flag configurations.	AdolescentDataFlagConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "enabled": true,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /immunizations/adolescent-data-flag-configurations

Creates a HealtheLife adolescent data flag configuration by associating the domain with the given adolescent data flag configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The adolescent data flag configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_AdolescentDataFlagConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Adolescent Data Flag Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Deletes the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-

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 HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}

PUT /immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Updates the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID. You cannot update the domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-
body	body	putImmunizationsAdolescentDataFlagConfigurations	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 HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "enabled": true,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Retrieves the HealtheLife immunizations adolescent data flag configuration with the given adolescent data flag configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single adolescent data flag configuration.	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_AdolescentDataFlagConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Immunizations Configurations

The immunizations configurations endpoint enables the retrieval of all of the configurations for immunizations for the specified application experience domain at the same time.

Retrieve a List of Immunizations Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/configurations',
  query: {
  'applicationExperienceDomain' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/configurations?applicationExperienceDomain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "policyTextConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "policyText": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "localeTexts": [
            {
              "locale": "en-US",
              "text": "Sample Policy Text."
            }
          ]
        }
      },
      "knowledgeBaseConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "knowledgeBase": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "facilityCd": "88389",
          "primaryCriteriaCd": "79995",
          "localeCodes": [
            {
              "locale": "en-US",
              "code": "65885."
            }
          ]
        }
      },
      "logoConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "logo": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "url": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
        }
      },
      "addressConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "address": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "localeAddresses": [
            {
              "locale": "en-US",
              "line1": "Cerner",
              "line2": "H2 block",
              "line3": "B Wing",
              "line4": "Manyata Tech Park",
              "line5": "Bangalore",
              "line6": "India"
            }
          ]
        }
      },
      "dataSourceConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "dataSource": "HEALTHEINTENT",
        "applicationExperienceDomain": "testapp.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      },
      "adolescentDataFlagConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "testapp.com",
        "enabled": true,
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      },
      "infoButtonConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "educationContentUrl": "https://immunizations.learnmore.com",
        "applicationExperienceDomain": "testapp.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/configurations?offset=0&limit=20"
}

GET /immunizations/configurations

Retrieves a list of all the configurations for immunizations that is paginated per the specified parameters. The response can also be filtered by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the configuration.	-
applicationExperienceDomain	query	string	true	N/A	The ID of the tenant’s environment.	-
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	A collection of policy texts.	AllConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Scheduling Closed Book Providers

Closed book providers are those who allow direct scheduling only if the patient has an established relationship with them. The scheduling closed book providers endpoints enable tenants to configure the following items:

Scheduling provider definitions: Provider definitions list the providers who use closed book scheduling.
Scheduling provider configurations: Provider configurations enable tenants to configure the provider definition for a domain.

Retrieve a List of Scheduling Provider 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/patient-portal-application/v1/scheduling-provider-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "cerner.com",
      "providerDefinition": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "providerIds": [
          "1234",
          "5678"
        ],
        "providers": [
          {
            "id": "12345",
            "name": "provider"
          }
        ]
      },
      "createdAt": "2020-08-03T06:10:25.843Z",
      "updatedAt": "2020-08-03T06:10:25.843Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations?offset=0&limit=20"
}

GET /scheduling-provider-configurations

Retrieves all the scheduling closed book provider configurations for the Health Data Intelligence tenant.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	The domain name of the tenant in the patient portal application to which the scheduling configuration belongs.	-
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	A collection of provider configurations.	GetProviderConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Scheduling Provider 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/patient-portal-application/v1/scheduling-provider-configurations', headers: headers, body: {"providerDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"providerDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "providerDefinitionId": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "cerner.com",
  "createdAt": "2020-08-03T06:10:25.843Z",
  "updatedAt": "2020-08-03T06:10:25.843Z"
}

POST /scheduling-provider-configurations

Creates a provider configuration for scheduling.

Parameters

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

Response Statuses

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

Update a Scheduling Provider 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/patient-portal-application/v1/scheduling-provider-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"providerDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"providerDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}

PUT /scheduling-provider-configurations/{id}

Updates the scheduling provider configuration with the given ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the provider configuration.	-
body	body	putSchedulingProviderConfigurations	true	N/A	No description	-

Response Statuses

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

Delete a Scheduling Provider Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /scheduling-provider-configurations/{id}

Deletes the scheduling provider configuration with the given ID.

Parameters

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

Response Statuses

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

Retrieve a List of Scheduling Provider 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/patient-portal-application/v1/scheduling-provider-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "providerIds": [
        "1234",
        "5678"
      ],
      "providers": [
        {
          "id": "12345",
          "name": "provider"
        }
      ],
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-definitions?offset=0&limit=20"
}

GET /scheduling-provider-definitions

Retrieves a list of provider definitions for scheduling.

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	A collection of provider definitions.	ProviderDefinitions
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Scheduling Provider 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/patient-portal-application/v1/scheduling-provider-definitions', headers: headers, body: {"providers":[{"id":"12345","name":"provider"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"providers":[{"id":"12345","name":"provider"}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "providerIds": [
    "1234",
    "5678"
  ],
  "providers": [
    {
      "id": "12345",
      "name": "provider"
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /scheduling-provider-definitions

Creates a provider definition for scheduling.

Parameters

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

Response Statuses

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

Delete a Scheduling Provider 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/patient-portal-application/v1/scheduling-provider-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /scheduling-provider-definitions/{id}

Deletes the provider definition with the given provider definition ID.

Parameters

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

Response Statuses

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

Guided Scheduling

The guided scheduling endpoints enable tenants to configure the questionnaire used to guide consumers through the process of scheduling appointments in a domain. Guided scheduling uses the following resources:

Guided Scheduling Definitions: Guided scheduling definitions enable tenants to define the questionnaire questions and answers for guided scheduling in a domain and the rules that determine when questions are displayed.
Guided Scheduling Configurations: Guided scheduling configurations enable tenants to configure the guided scheduling definition and questionnaire that is used in a domain.

Retrieve a List of Guided Scheduling 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/patient-portal-application/v1/guided-scheduling-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "987651ed-c304-4737-93d9-78615b6a1pa2",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "questionnaires": [
        {
          "id": "987651ed-c304-4737-93d9-78615b6a1pa2",
          "name": "Cerner Guided Scheduling Questionnaire",
          "locale": "en-US",
          "description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations?offset=0&limit=20"
}

GET /guided-scheduling-configurations

Retrieves all the guided scheduling configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	The domain name of the tenant in the patient portal application to which the guided scheduling configuration belongs.	-
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	OK	GetGuidedConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Guided Scheduling 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/patient-portal-application/v1/guided-scheduling-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","questionnaires":[{"id":"4axc897s-polq-98eq-b597-789aa3871pls"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","questionnaires":[{"id":"4axc897s-polq-98eq-b597-789aa3871pls"}]}

{
  "id": "987651ed-c304-4737-93d9-78615b6a1pa2",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "questionnaires": [
    {
      "id": "4axc897s-polq-98eq-b597-789aa3871pls"
    }
  ]
}

POST /guided-scheduling-configurations

Creates a new guided scheduling configuration.

Parameters

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

Response Statuses

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

Retrieve a Single Guided Scheduling 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/patient-portal-application/v1/guided-scheduling-configurations/{id}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations/{id} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "987651ed-c304-4737-93d9-78615b6a1pa2",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "questionnaires": [
    {
      "id": "987651ed-c304-4737-93d9-78615b6a1pa2",
      "name": "Cerner Guided Scheduling Questionnaire",
      "locale": "en-US",
      "description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."
    }
  ]
}

GET /guided-scheduling-configurations/{id}

Retrieves the guided scheduling configuration with the specified ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	OK	GetGuidedConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Guided Scheduling 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/patient-portal-application/v1/guided-scheduling-configurations/{id}', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","questionnaires":[{"id":"4axc897s-polq-98eq-b597-789aa3871pls"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations/{id} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","questionnaires":[{"id":"4axc897s-polq-98eq-b597-789aa3871pls"}]}

PUT /guided-scheduling-configurations/{id}

Updates the guided scheduling configuration with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the guided scheduling configuration.	-
body	body	putGuidedSchedulingConfigurations	true	N/A	No description	-

Response Statuses

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

Delete a Guided Scheduling Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations/{id}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations/{id} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /guided-scheduling-configurations/{id}

Deletes the guided scheduling configuration with the specified ID.

Parameters

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

Response Statuses

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

Create a Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires', headers: headers, body: {"name":"Cerner Guided Scheduling Questionnaire","locale":"en-US","description":"Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cerner Guided Scheduling Questionnaire","locale":"en-US","description":"Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "name": "Cerner Guided Scheduling Questionnaire",
  "locale": "en-US",
  "description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users.",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /scheduling-questionnaires

Creates a new guided scheduling questionnaire for the guided scheduling definition.

Parameters

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

Response Statuses

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

Retrieve a List of Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "name": "Cerner Guided Scheduling Questionnaire",
      "locale": "en-US",
      "description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users.",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires?offset=0&limit=20"
}

GET /scheduling-questionnaires

Retrieve all the guided scheduling questionnaires for the guided scheduling definition.

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	OK	GetQuestionnaires
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a Single Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "locale": "en-US",
  "name": "Cerner Guided Scheduling Questionnaire",
  "description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users.",
  "questions": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "text": "Are you a new patient or an established patient?",
      "options": [
        {
          "id": "675411oo-f123-8907-93d3-2375b6a1cd5",
          "text": "New Patient",
          "appointmentType": {
            "appointmentSynonymCode": "703265169"
          }
        }
      ],
      "rules": [
        {
          "question": {
            "id": "78bc3048-fb35-46a9-88e5-66f61993a969"
          },
          "option": {
            "id": "d3c30094-7a02-42b8-9006-95fada46b865"
          }
        }
      ]
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /scheduling-questionnaires/{questionnaireId}

Retrieves the guided scheduling questionnaire with the specified ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Guided Scheduling Questionnaire	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_GetQuestionnairesId
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Guided Scheduling Questionnaire




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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}', headers: headers, body: {"name":"Cerner Guided Scheduling Questionnaire","locale":"en-US","description":"Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cerner Guided Scheduling Questionnaire","locale":"en-US","description":"Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."}

PUT /scheduling-questionnaires/{questionnaireId}

Update the guided scheduling questionnaire with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireId	path	string	true	N/A	The ID of the Guided Scheduling Questionnaire.	-
body	body	putSchedulingQuestionnaires	true	N/A	No description	-

Response Statuses

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

Delete a Guided Scheduling Questionnaire


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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /scheduling-questionnaires/{questionnaireId}

Deletes the guided scheduling questionnaire with the specified ID.

Parameters

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

Response Statuses

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

Create a Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions', headers: headers, body: {"questions":[{"text":"Are you a new patient or an established patient?","options":[{"text":"Yes"},{"text":"No"}]}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"questions":[{"text":"Are you a new patient or an established patient?","options":[{"text":"Yes"},{"text":"No"}]}]}

{
  "questions": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "text": "Are you a new patient or an established patient?",
      "options": [
        {
          "id": "784413ps-c924-4737-93f9-52315s6a1qw5",
          "text": "Yes"
        },
        {
          "id": "312456ps-c112-1237-22f9-34515s6a1ax5",
          "text": "No"
        }
      ],
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ]
}

POST /scheduling-questionnaires/{questionnaireId}/questions

Create a new set of guided scheduling questions for the guided scheduling definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireId	path	string	true	N/A	The ID of the Guided Scheduling Questionnaire.	-
body	body	postSchedulingQuestionnairesQuestionnaireidQuestions	true	N/A	No description	-

Response Statuses

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

Retrieve a List of Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "text": "Are you a new patient or an established patient?",
      "options": [
        {
          "id": "784413ps-c924-4737-93f9-52315s6a1qw5",
          "text": "Yes"
        },
        {
          "id": "312456ps-c112-1237-22f9-34515s6a1ax5",
          "text": "No"
        }
      ],
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/questionnaire_id/questions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/questionnaire_id/questions?offset=0&limit=20"
}

GET /scheduling-questionnaires/{questionnaireId}/questions

Retrieve all the guided scheduling questions for the guided scheduling definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireId	path	string	true	N/A	The ID of the Guided Scheduling Questionnaire.	-
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	OK	GetQuestionnairesQuestions
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions/{id}', headers: headers, body: {"text":"Are you a new patient or an established patient?","options":[{"id":"784413ps-c924-4737-93f9-52315s6a1qw5","text":"Yes"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions/{id} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Are you a new patient or an established patient?","options":[{"id":"784413ps-c924-4737-93f9-52315s6a1qw5","text":"Yes"}]}

PUT /scheduling-questionnaires/{questionnaireId}/questions/{id}

Updates the guided scheduling question with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the guided scheduling questionnaire question.	-
questionnaireId	path	integer(int32)	true	N/A	No description	-
body	body	putSchedulingQuestionnairesQuestionnaireidQuestions	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 Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions/{id}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions/{id} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "text": "Are you a new patient or an established patient?",
  "options": [
    {
      "id": "784413ps-c924-4737-93f9-52315s6a1qw5",
      "text": "Yes"
    },
    {
      "id": "312456ps-c112-1237-22f9-34515s6a1ax5",
      "text": "No"
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /scheduling-questionnaires/{questionnaireId}/questions/{id}

Retrieves the guided scheduling question with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the guided scheduling questionnaire question.	-
questionnaireId	path	integer(int32)	true	N/A	No description	-

Response Statuses

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

Delete a Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions/{id}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/questions/{id} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /scheduling-questionnaires/{questionnaireId}/questions/{id}

Deletes the guided scheduling question with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the guided scheduling questionnaire question.	-
questionnaireId	path	integer(int32)	true	N/A	No description	-

Response Statuses

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

Create a Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules', headers: headers, body: {"rules":[{"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"},"appointmentType":{"appointmentSynonymCode":"568734656"}},{"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"appointmentType":{"appointmentSynonymCode":"703265169"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"}}],"appointmentType":{"appointmentSynonymCode":"703265169"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"rules":[{"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"},"appointmentType":{"appointmentSynonymCode":"568734656"}},{"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"appointmentType":{"appointmentSynonymCode":"703265169"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"}}],"appointmentType":{"appointmentSynonymCode":"703265169"}}

{
  "rules": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "question": {
        "id": "78bc3048-fb35-46a9-88e5-66f61993a969"
      },
      "option": {
        "id": "d3c30094-7a02-42b8-9006-95fada46b865"
      },
      "linkedQuestion": {
        "id": "487038rf-h123-5557-93e9-90815b6a1cd5"
      },
      "appointmentType": {
        "appointmentSynonymCode": "703265169"
      },
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    },
    {
      "id": "p09543w1-aef5-493c-3r54-dfd842c2as56",
      "question": {
        "id": "78bc3048-fb35-46a9-88e5-66f61993a969"
      },
      "option": {
        "id": "d3c30094-7a02-42b8-9006-95fada46b865"
      },
      "appointmentType": {
        "appointmentSynonymCode": "703265169"
      },
      "linkedQuestion": {
        "id": "487038rf-h123-5557-93e9-90815b6a1cd5"
      },
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ]
}

POST /scheduling-questionnaires/{questionnaireId}/rules

Creates a new guided scheduling rule.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireId	path	string	true	N/A	The ID of the Guided Scheduling Questionnaire.	-
body	body	postSchedulingQuestionnairesQuestionnaireidRules	true	N/A	No description	-

Response Statuses

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

Retrieve a List of Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "question": {
        "id": "78bc3048-fb35-46a9-88e5-66f61993a969"
      },
      "option": {
        "id": "d3c30094-7a02-42b8-9006-95fada46b865"
      },
      "linkedQuestion": {
        "id": "487038rf-h123-5557-93e9-90815b6a1cd5"
      },
      "appointmentType": {
        "appointmentSynonymCode": "703265169"
      },
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/questionnaire_id/rules?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/questionnaire_id/rules?offset=0&limit=20"
}

GET /scheduling-questionnaires/{questionnaireId}/rules

Retrieves all the guided scheduling rules.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
questionnaireId	path	string	true	N/A	The ID of the Guided Scheduling Questionnaire.	-
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	OK	GetQuestionnaireRules
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules/{id}', headers: headers, body: {"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"},"appointmentType":{"appointmentSynonymCode":"703265169"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules/{id} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"},"appointmentType":{"appointmentSynonymCode":"703265169"}}

PUT /scheduling-questionnaires/{questionnaireId}/rules/{id}

Updates the guided scheduling rule with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the guided scheduling questionnaire rule.	-
questionnaireId	path	integer(int32)	true	N/A	No description	-
body	body	putSchedulingQuestionnairesQuestionnaireidRules	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

Get a Guided Scheduling Rule by ID


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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules/{id}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules/{id} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "question": {
    "id": "78bc3048-fb35-46a9-88e5-66f61993a969"
  },
  "option": {
    "id": "d3c30094-7a02-42b8-9006-95fada46b865"
  },
  "linkedQuestion": {
    "id": "487038rf-h123-5557-93e9-90815b6a1cd5"
  },
  "appointmentType": {
    "appointmentSynonymCode": "703265169"
  },
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /scheduling-questionnaires/{questionnaireId}/rules/{id}

Retrieves a single Guided Scheduling Rule

Parameters

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

Response Statuses

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

Delete a Guided Scheduling 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/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules/{id}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/{questionnaireId}/rules/{id} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /scheduling-questionnaires/{questionnaireId}/rules/{id}

Deletes the guided scheduling rule with the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The ID of the guided scheduling questionnaire rule.	-
questionnaireId	path	integer(int32)	true	N/A	No description	-

Response Statuses

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

Scheduling Geolocations

The scheduling geolocation endpoints allow you to configure appointment locations and retrieve the nearest appointment locations for a patient for a given tenant. The following items can be configured and retrieved using the endpoints:

Load Appointment Locations: You can create a list of appointment locations in bulk and override the existing data.
Appointment Locations:You can retrieve the appointment locations for a given Health Data Intelligence tenant.

Retrieve a List of Appointment 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/patient-portal-application/v1/scheduling-appointment-locations',
  query: {
  'applicationExperienceDomain' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-appointment-locations?applicationExperienceDomain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.us.healtheintent.com",
      "locationId": "26222027",
      "name": "Cerner Clinic",
      "phone": "0000000000",
      "phoneExt": "800",
      "street1": "2800 Rock Creek Pkwy",
      "street2": "street2",
      "street3": "street3",
      "street4": "street4",
      "city": "Kansas City",
      "state": "MO",
      "postalCode": "WDR454",
      "country": "USA",
      "latitude": "12.67",
      "longitude": "17.76",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-appointment-locations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-appointment-locations?offset=0&limit=20"
}

GET /scheduling-appointment-locations

Retrieves all of the appointment locations for the given Health Data Intelligence tenant ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	true	N/A	The domain name of a tenant in the patient portal application that uses the geolocation service.	-
sourceLocation	query	string	false	N/A	The source location needed to calculate the nearest appointment locations.	-
milesLimit	query	string	false	N/A	The maximum number of miles away from the patient’s address that the appointment locations should be.	-
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	A collection of appointment locations.	AppointmentLocationsEntities
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Searches all appointment locations for the given Health Data Intelligence tenant based on primary search criteria of source and distance then based on secondary search criteria of location IDs of the appointments.




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/patient-portal-application/v1/appointment-locations/search', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-locations/search \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.us.healtheintent.com",
      "locationId": "26222027",
      "name": "Cerner Clinic",
      "phone": "0000000000",
      "phoneExt": "800",
      "street1": "2800 Rock Creek Pkwy",
      "street2": "street2",
      "street3": "street3",
      "street4": "street4",
      "city": "Kansas City",
      "state": "MO",
      "postalCode": "WDR454",
      "country": "USA",
      "latitude": "12.67",
      "longitude": "17.76",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-locations/search?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-locations/search?offset=0&limit=20"
}

POST /appointment-locations/search

Searches appointment locations for scheduling.

Parameters

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

Response Statuses

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

Create a List of Appointment Locations




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/patient-portal-application/v1/scheduling-load-appointment-locations', headers: headers, body: {"appointmentLocations":[{"applicationExperienceDomain":"dev.us.healtheintent.com","locationId":"26222027","name":"Cerner Clinic","phone":"0000000000","phoneExt":"800","street1":"2800 Rock Creek Pkwy","street2":"street2","street3":"street3","street4":"street4","city":"Kansas City","state":"MO","postalCode":"WDR454","country":"USA"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-load-appointment-locations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"appointmentLocations":[{"applicationExperienceDomain":"dev.us.healtheintent.com","locationId":"26222027","name":"Cerner Clinic","phone":"0000000000","phoneExt":"800","street1":"2800 Rock Creek Pkwy","street2":"street2","street3":"street3","street4":"street4","city":"Kansas City","state":"MO","postalCode":"WDR454","country":"USA"}]}

POST /scheduling-load-appointment-locations

Creates a list of appointment locations for a given Health Data Intelligence tenant ID in bulk and overrides the existing data.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
202	Accepted	Accepted	PatientPortalApplicationPublicApi_Entities_V1_SchedulingGeoLocation_AppointmentLocationJob
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve Status of Appointment Location Delayed Job


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/patient-portal-application/v1/appointment-locations-import-status',
  query: {
  'domain' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-locations-import-status?domain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "applicationExperienceDomain": "dev.us.healtheintent.com",
  "jobStatus": "success",
  "lastModified": "2020-01-20T05:40:02.000Z"
}

GET /appointment-locations-import-status

Retrieves the status of the appointment location delayed job for the given Health Data Intelligence tenantID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	true	N/A	The domain name of a tenant in the patient portal application that uses the geolocation service.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Status of appointment location delayed job.	PatientPortalApplicationPublicApi_Entities_V1_SchedulingGeoLocation_JobTracker
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Report Configuration

The report configuration endpoints enable tenants to configure the following items:

Report Definitions: Report definitions enable you to define the attributes of the report. The following attributes define how and when the report is displayed in the portal for the consumer:
- Event set name: Identifies the report.
- Start date: The start date on which reports are displayed in the portal.
- Publish hours: The publishing time delay in hours.
- Statuses: Indicates whether the Unauthenticated, Transcribed, and In-Progress statuses are enabled. If a status is enabled, the reports in the status are displayed in the portal.
Report Configurations: Report configurations enable configuring the application experience domain for the report definition. This includes storing, updating, and deleting the report definition associated with the application experience domain. One report definition can be associated with multiple application experience domains, but one domain cannot be associated with multiple report definitions.

Retrieve a List of Report 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/patient-portal-application/v1/reports/report-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "report": "CARDIOLOGY",
      "displayStartDate": "2020-01-20",
      "displayUnauthenticated": "true",
      "displayTranscribed": "true",
      "displayInProgress": "true",
      "isReportsEnabled": "true",
      "categories": [
        {
          "name": "CARDIOLOGY_REPORT_OBSTYPE",
          "publishDelayHours": 0
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions?offset=0&limit=20"
}

GET /reports/report-definitions

Retrieves a list of report definitions.

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

Create a Report 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/patient-portal-application/v1/reports/report-definitions', headers: headers, body: {"report":"CARDIOLOGY","displayStartDate":"2020-01-20","displayUnauthenticated":"true","displayTranscribed":"true","displayInProgress":"true","isReportsEnabled":"true","categories":[{"name":"CARDIOLOGY_REPORT_OBSTYPE","publishDelayHours":0}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"report":"CARDIOLOGY","displayStartDate":"2020-01-20","displayUnauthenticated":"true","displayTranscribed":"true","displayInProgress":"true","isReportsEnabled":"true","categories":[{"name":"CARDIOLOGY_REPORT_OBSTYPE","publishDelayHours":0}]}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "report": "CARDIOLOGY",
  "displayStartDate": "2020-01-20",
  "displayUnauthenticated": "true",
  "displayTranscribed": "true",
  "displayInProgress": "true",
  "isReportsEnabled": "true",
  "categories": [
    {
      "name": "CARDIOLOGY_REPORT_OBSTYPE",
      "publishDelayHours": 0
    }
  ]
}

POST /reports/report-definitions

Creates a new report definition.

Parameters

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

Response Statuses

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

Delete a Report 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/patient-portal-application/v1/reports/report-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /reports/report-definitions/{reportDefinitionId}

Deletes a specific report definition. A report definition cannot be deleted if it is associated with an application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
reportDefinitionId	path	string	true	N/A	The unique ID of the report definition associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Single Report 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/patient-portal-application/v1/reports/report-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "report": "CARDIOLOGY",
  "displayStartDate": "2020-01-20",
  "displayUnauthenticated": "true",
  "displayTranscribed": "true",
  "displayInProgress": "true",
  "isReportsEnabled": "true",
  "categories": [
    {
      "name": "CARDIOLOGY_REPORT_OBSTYPE",
      "publishDelayHours": 0
    }
  ]
}

GET /reports/report-definitions/{reportDefinitionId}

Retrieves a single report definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
reportDefinitionId	path	string	true	N/A	The unique ID of the report definition associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a List of Report 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/patient-portal-application/v1/reports/report-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "reportDefinitions": [
        {
          "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
          "report": "CARDIOLOGY",
          "displayStartDate": "2020-01-20",
          "displayUnauthenticated": "true",
          "displayTranscribed": "true",
          "displayInProgress": "true",
          "isReportsEnabled": "true",
          "categories": [
            {
              "name": "CARDIOLOGY_REPORT_OBSTYPE",
              "publishDelayHours": 0
            }
          ]
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations?offset=0&limit=20"
}

GET /reports/report-configurations

Retrieves a list of report configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	OK	GetReportConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Report 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/patient-portal-application/v1/reports/report-configurations', headers: headers, body: {"reportDefinitions":[{"reportDefinitionId":"262038ed-c304-4737-93d9-55615b6a1cd5"}],"applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"reportDefinitions":[{"reportDefinitionId":"262038ed-c304-4737-93d9-55615b6a1cd5"}],"applicationExperienceDomain":"dev.healtheintent.com"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "reportDefinitions": [
    {
      "reportDefinitionId": "262038ed-c304-4737-93d9-55615b6a1cd5"
    }
  ]
}

POST /reports/report-configurations

Creates a new report configuration.

Parameters

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

Response Statuses

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

Update a Report 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/patient-portal-application/v1/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"reportDefinitions":[{"reportDefinitionId":"262038ed-c304-4737-93d9-55615b6a1cd5"}],"applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"reportDefinitions":[{"reportDefinitionId":"262038ed-c304-4737-93d9-55615b6a1cd5"}],"applicationExperienceDomain":"dev.healtheintent.com"}

PUT /reports/report-configurations/{reportConfigurationId}

Updates a specific report configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
reportConfigurationId	path	string	true	N/A	The unique ID of the report configuration associated with the Health Data Intelligence tenant.	-
body	body	putReportsReportConfigurations	true	N/A	No description	-

Response Statuses

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

Delete a Report Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /reports/report-configurations/{reportConfigurationId}

Deletes a specific report configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
reportConfigurationId	path	string	true	N/A	The unique ID of the report configuration associated with the Health Data Intelligence tenant.	-

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

Retrieve a Single Report 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/patient-portal-application/v1/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "reportDefinitions": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "report": "CARDIOLOGY",
      "displayStartDate": "2020-01-20",
      "displayUnauthenticated": "true",
      "displayTranscribed": "true",
      "displayInProgress": "true",
      "isReportsEnabled": "true",
      "categories": [
        {
          "name": "CARDIOLOGY_REPORT_OBSTYPE",
          "publishDelayHours": 0
        }
      ]
    }
  ]
}

GET /reports/report-configurations/{reportConfigurationId}

Retrieves a specific report configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
reportConfigurationId	path	string	true	N/A	The unique ID of the report configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Reports Policy Text Configuration

The Reports Policy Text Configuration endpoints enable tenants to configure the following items:

Policy Text Definitions: Policy text definitions enable adding the policies, disclaimer, and other important information related to the reports page that is displayed to the consumer in a specific language and locale. This mainly applies to reports for cardiology, microbiology, pathology, and radiology. This allows tenants to create only one policy text definition for a locale. The locale is the language code, for example, en-US.
Policy Text Configurations: Policy text configurations enable the configuration of application experience domains for policy texts. This includes storing, updating, and deleting the policy text definition’s associated with the application experience domain. Associating the policy text with the domain allows the text to be displayed in that domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.

Retrieve a List of Reports Policy Texts 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/patient-portal-application/v1/reports/policy-text-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions?offset=0&limit=20"
}

GET /reports/policy-text-definitions

Retrieves a list of policy text definitions for reports.

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	A collection of reports policy texts.	PolicyTextDefinitions
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Reports Policy Text 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/patient-portal-application/v1/reports/policy-text-definitions', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

POST /reports/policy-text-definitions

Creates a new policy text definition for reports.

Parameters

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

Response Statuses

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

Delete a Reports Policy Text 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/patient-portal-application/v1/reports/policy-text-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /reports/policy-text-definitions/{policyTextDefinitionId}

Deletes a specific reports policy text definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
policyTextDefinitionId	path	string	true	N/A	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Single Reports Policy Text 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/patient-portal-application/v1/reports/policy-text-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

GET /reports/policy-text-definitions/{policyTextDefinitionId}

Retrieves a single policy text definition for reports.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
policyTextDefinitionId	path	string	true	N/A	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text for reports.	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PolicyTextDefinition
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Reports Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "policyTextDefinition": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "localeTexts": [
          {
            "locale": "en-US",
            "text": "Sample Policy Text."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations?offset=0&limit=20"
}

GET /reports/policy-text-configurations

Retrieves a list of policy text configurations for reports.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the ID of the tenant’s environment.	-
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
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	A collection of policy text configurations for reports.	GetPolicyTextConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Reports Policy Text 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/patient-portal-application/v1/reports/policy-text-configurations', headers: headers, body: {"policyTextDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyTextDefinitionId": "262038ed-c304-4737-93d9-55615b6a1ce6"
}

POST /reports/policy-text-configurations

Creates a policy text configuration for reports.

Parameters

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

Response Statuses

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

Update a Reports Policy Text 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/patient-portal-application/v1/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}

PUT /reports/policy-text-configurations/{policyTextConfigurationId}

Updates a policy text configuration for reports. Only the policy text ID can be updated; the application experience domain cannot be.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
policyTextConfigurationId	path	string	true	N/A	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
body	body	putReportsPolicyTextConfigurations	true	N/A	No description	-

Response Statuses

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

Delete a Reports Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /reports/policy-text-configurations/{policyTextConfigurationId}

Deletes a policy text configuration for reports.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
policyTextConfigurationId	path	string	true	N/A	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-

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

Retrieve a Single Reports Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyTextDefinition": {
    "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
    "localeTexts": [
      {
        "locale": "en-US",
        "text": "Sample Policy Text."
      }
    ]
  }
}

GET /reports/policy-text-configurations/{policyTextConfigurationId}

Retrieves a specific report policy text configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
policyTextConfigurationId	path	string	true	N/A	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text configuration for reports.	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_GetPolicyTextConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Reports Adolescent Data Flag Configuration

The Reports Adolescent Data Flag Configuration endpoints enable tenants to configure the adolescent data flag for an application experience domain and report type. This includes storing, updating, and deleting the adolescent data flag configuration associated with the application experience domain and report type. One adolescent data flag configuration can be associated with one application experience domain and report type.

Retrieve a List of HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/reports/adolescent-data-flag-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "testapp.com",
      "report": "CARDIOLOGY",
      "enabled": "true",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/adolescent-data-flag-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/adolescent-data-flag-configurations?offset=0&limit=20"
}

GET /reports/adolescent-data-flag-configurations

Retrieves a list of all the HealtheLife adolescent data flag configurations that are paginated per the specified parameters. The response can also be filtered by domain or report or both.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife adolescent data flag configurations belong.	-
report	query	string	false	N/A	Filters by the domain to which the HealtheLife adolescent data flag configurations belong.	CARDIOLOGY, MICROBIOLOGY, PATHOLOGY, RADIOLOGY
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	A collection of adolescent data flag configurations.	AdolescentDataFlagConfigs
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/reports/adolescent-data-flag-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","report":"CARDIOLOGY","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","report":"CARDIOLOGY","enabled":true}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "report": "CARDIOLOGY",
  "enabled": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /reports/adolescent-data-flag-configurations

Creates a HealtheLife adolescent data flag configuration by associating the domain and report with the given adolescent data flag configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The adolescent data flag configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_AdolescentDataFlagConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Adolescent Data Flag Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /reports/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Deletes the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-

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 HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/reports/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","report":"CARDIOLOGY","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","report":"CARDIOLOGY","enabled":true}

PUT /reports/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Updates the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID. The domain and report type cannot be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-
body	body	putReportsAdolescentDataFlagConfigurations	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

Retrieve a Single HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/reports/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "report": "CARDIOLOGY",
  "enabled": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /reports/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Retrieves the HealtheLife reports adolescent data flag configuration with the given adolescent data flag configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single adolescent data flag configuration.	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_AdolescentDataFlagConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Reports Data Source Configurations

Reports data source configurations allow you to select reports data from either Health Data Intelligence Longitudinal Record or Cerner Millennium for an application experience domain. You can also delete the configuration if it is no longer required.

Retrieve a List of HealtheLife Reports Data Source 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/patient-portal-application/v1/reports/data-source-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/data-source-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "dataSource": "HEALTHEINTENT",
      "applicationExperienceDomain": "testapp.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/data-source-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/data-source-configurations?offset=0&limit=20"
}

GET /reports/data-source-configurations

Retrieves a list of all the HealtheLife reports data source configurations that are paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife data source configurations belong.	-
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	A collection of data source configurations.	DataSourceConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Data Source 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/patient-portal-application/v1/reports/data-source-configurations', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/data-source-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "dataSource": "HEALTHEINTENT",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /reports/data-source-configurations

Creates a HealtheLife data source configuration by associating the domain with the given data source configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The data source configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_DataSourceConfiguration
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Reports Data Source Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /reports/data-source-configurations/{id}

Deletes the HealtheLife reports data source configuration with the given data source configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-

Response Statuses

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

Update a HealtheLife Reports Data Source 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/patient-portal-application/v1/reports/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /reports/data-source-configurations/{id}

Updates the HealtheLife reports data source configuration with the given data source configuration ID. You cannot update the domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-
body	body	putReportsDataSourceConfigurations	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

Retrieve a Single HealtheLife Reports Data Source 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/patient-portal-application/v1/reports/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "dataSource": "HEALTHEINTENT",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /reports/data-source-configurations/{id}

Retrieves the HealtheLife reports data source configuration with the given data source configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A data source configuration.	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_DataSourceConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Reports Configurations

The Reports Configurations endpoint enables retrieving all the configurations for reports for the specified application experience domain at the same time.

Retrieve a List of Reports Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/configurations',
  query: {
  'applicationExperienceDomain' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/configurations?applicationExperienceDomain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "policyTextConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "policyTextDefinition": {
          "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
          "localeTexts": [
            {
              "locale": "en-US",
              "text": "Sample Policy Text."
            }
          ]
        }
      },
      "reportConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "reportDefinitions": [
          {
            "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
            "report": "CARDIOLOGY",
            "displayStartDate": "2020-01-20",
            "displayUnauthenticated": "true",
            "displayTranscribed": "true",
            "displayInProgress": "true",
            "isReportsEnabled": "true",
            "categories": [
              {
                "name": "CARDIOLOGY_REPORT_OBSTYPE",
                "publishDelayHours": 0
              }
            ]
          }
        ]
      },
      "adolescentDataFlagConfigurations": [
        {
          "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
          "applicationExperienceDomain": "testapp.com",
          "report": "CARDIOLOGY",
          "enabled": "true",
          "createdAt": "2020-01-20T05:40:02.000Z",
          "updatedAt": "2020-01-20T05:40:02.000Z"
        }
      ],
      "dataSourceConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "dataSource": "HEALTHEINTENT",
        "applicationExperienceDomain": "testapp.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/configurations?offset=0&limit=20"
}

GET /reports/configurations

Retrieves a list of all the configurations for reports for the specified application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	true	N/A	Filters by the domain to which the tenant ID belongs.	-
Accept-Language	header	string	false	en-US	The locale of the configuration to be retrieved.	-
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	OK	ReportAllConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Consumer Enrollment

The Consumer Enrollment resource allows you to enroll consumers in a patient portal application. The main intent is to connect the enrolling patient to their Cerner Millennium patient records and to provide access to them in a patient portal application. The system completes the following operations to perform this action:

Confirm a Health Data Intelligence consumer account exists for the consumer.
Set the federated principal alias of the Cerner Millennium person for the consumer.
Set the messaging alias for the Cerner Millennium person in context if one does not exist.
Assign the PATIENT_AUTH_REP site role to the consumer.

Note: To enroll a consumer, the following items must be configured for the specified domain URI:

Cerner must create a patient enrollment configuration for the tenant and domain URI. Contact your Cerner representative or log a service record (SR) in eService to request a patient enrollment configuration.
A site definition with a roleId value of PATIENT_AUTH_REP must be created. See the Site Definition section for more information.
Cerner Millennium configurations must be created. See the Cerner Millennium Configuration section for more information.

Enroll a Consumer in a Patient Portal Application




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/patient-portal-application/v1/consumer-enrollments', headers: headers, body: {"domainUri":"mill-func-test.patientportal.us.devhealtheintent.com","consumer":{"id":"8e4265fa-8d33-4235-88a3-02ae7e36546e","principalAlias":"urn:cerner:identity-federation:realm:24956dc2-a2cc-11e6-80f5:principal:sm4nk9w92ak","millenniumPatientId":"773933"},"person":{"millenniumPatientId":"999932"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollments \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domainUri":"mill-func-test.patientportal.us.devhealtheintent.com","consumer":{"id":"8e4265fa-8d33-4235-88a3-02ae7e36546e","principalAlias":"urn:cerner:identity-federation:realm:24956dc2-a2cc-11e6-80f5:principal:sm4nk9w92ak","millenniumPatientId":"773933"},"person":{"millenniumPatientId":"999932"}}

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "consumer": {
    "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476"
  },
  "createdAt": "2020-12-15T12:23:12Z"
}

POST /consumer-enrollments

Creates a consumer enrollment in a patient portal application.

Parameters

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

Response Statuses

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

Consumer Enrollment Configurations

Consumer enrollment configurations help create and store the information that is required during the process of enrolling consumers into a patient portal application. These configurations define how consumer data or patient data is updated to ensure a successful enrollment. They are scoped to a domain using consumer enrollment site configurations. This process includes the following steps:

Create an enrollment configuration instance.
Associate the configuration instance created in the previous step to a site. You can also update the association in the future.

Create a Consumer Enrollment Configuration




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-configurations', headers: headers, body: {"fpaPoolCode":496272779,"messagingAliasPoolCode":20410763,"millenniumDataPartitionId":"511d71b2-c065-4799-a0e4-7039086f95d3","isMillenniumRelationship":true,"existingPatientWorkflowEnabled":true,"previousCareReceivedPromptTitle":[{"locale":"en-US","text":"Have you ever received care from this provider before?"}],"previousCareReceivedPromptDescription":[{"locale":"en-US","text":"<p>If you are 18 or older and have been seen as a patient before, select **Yes** to complete the self-enrollment process to view your medical information and connect with your healthcare team. If you are a new patient, select **No** to enroll.</p><p>After selecting **Yes**, you will self-enroll to link your portal account to your medical record. If enrollment succeeds, restart the On-Demand Video Visit from the dashboard. If enrollment does not succeed, return to the dashboard, restart the On-Demand Video Visit, and select **No** on this page.</p>"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"fpaPoolCode":496272779,"messagingAliasPoolCode":20410763,"millenniumDataPartitionId":"511d71b2-c065-4799-a0e4-7039086f95d3","isMillenniumRelationship":true,"existingPatientWorkflowEnabled":true,"previousCareReceivedPromptTitle":[{"locale":"en-US","text":"Have you ever received care from this provider before?"}],"previousCareReceivedPromptDescription":[{"locale":"en-US","text":"<p>If you are 18 or older and have been seen as a patient before, select **Yes** to complete the self-enrollment process to view your medical information and connect with your healthcare team. If you are a new patient, select **No** to enroll.</p><p>After selecting **Yes**, you will self-enroll to link your portal account to your medical record. If enrollment succeeds, restart the On-Demand Video Visit from the dashboard. If enrollment does not succeed, return to the dashboard, restart the On-Demand Video Visit, and select **No** on this page.</p>"}]}

{
  "id": "ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e",
  "fpaPoolCode": 977272694,
  "messagingAliasPoolCode": 36701402,
  "millenniumDataPartitionId": "511d71b2-c065-4799-a0e4-7039086f95d3",
  "isMillenniumRelationship": true,
  "usesHealthelifePortal": true,
  "existingPatientWorkflowEnabled": true,
  "previousCareReceivedPromptTitle": [
    {
      "locale": "en-US",
      "text": "Have you previously received care at this healthcare organization?"
    }
  ],
  "previousCareReceivedPromptDescription": [
    {
      "locale": "en-US",
      "text": "<p>If you are 18 years or older and have ever been a patient at our healthcare organization, including Hospital, Clinic, Laboratory and Radiology, or other department, we may already have a medical record for you. Select **Yes** to complete the enrollment process before accessing our On Demand Video Visit service. If you have never been a patient at any of our facilities, select **No**.</p><p>If you select **Yes**, you will be directed to a self-enrollment process to link your portal account to your medical record. If enrollment succeeds, relaunch the On Demand Video Visit service from the home page. If enrollment is not completed, return to the home page and restart the On Demand Video Visit Service and select **No** when reaching this page./p><p>If you select **No**, you will be enrolled for access to our On Demand Video Visit service.</p>"
    }
  ]
}

POST /consumer-enrollment-configurations

Creates a consumer enrollment configuration for this tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Create a Consumer Enrollment Configuration	ConsumerEnrollmentConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Consumer Enrollment Configurations


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-configurations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e",
      "fpaPoolCode": 977272694,
      "messagingAliasPoolCode": 36701402,
      "millenniumDataPartitionId": "511d71b2-c065-4799-a0e4-7039086f95d3",
      "isMillenniumRelationship": true,
      "usesHealthelifePortal": true,
      "existingPatientWorkflowEnabled": true,
      "previousCareReceivedPromptTitle": [
        {
          "locale": "en-US",
          "text": "Have you previously received care at this healthcare organization?"
        }
      ],
      "previousCareReceivedPromptDescription": [
        {
          "locale": "en-US",
          "text": "<p>If you are 18 years or older and have ever been a patient at our healthcare organization, including Hospital, Clinic, Laboratory and Radiology, or other department, we may already have a medical record for you. Select **Yes** to complete the enrollment process before accessing our On Demand Video Visit service. If you have never been a patient at any of our facilities, select **No**.</p><p>If you select **Yes**, you will be directed to a self-enrollment process to link your portal account to your medical record. If enrollment succeeds, relaunch the On Demand Video Visit service from the home page. If enrollment is not completed, return to the home page and restart the On Demand Video Visit Service and select **No** when reaching this page./p><p>If you select **No**, you will be enrolled for access to our On Demand Video Visit service.</p>"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-configurations?offset=0&limit=20"
}

GET /consumer-enrollment-configurations

Retrieves a list of consumer enrollment configurations for a given tenant.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a List of Consumer Enrollment Configurations	ConsumerEnrollmentConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Single Consumer Enrollment Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-configurations/{configurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-configurations/{configurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /consumer-enrollment-configurations/{configurationId}

Deletes the consumer enrollment configuration for this tenant and given ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Delete a Single Consumer Enrollment Configuration	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Consumer Enrollment Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-configurations/{configurationId}', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e",
  "fpaPoolCode": 977272694,
  "messagingAliasPoolCode": 36701402,
  "millenniumDataPartitionId": "511d71b2-c065-4799-a0e4-7039086f95d3",
  "isMillenniumRelationship": true,
  "usesHealthelifePortal": true,
  "existingPatientWorkflowEnabled": true,
  "previousCareReceivedPromptTitle": [
    {
      "locale": "en-US",
      "text": "Have you previously received care at this healthcare organization?"
    }
  ],
  "previousCareReceivedPromptDescription": [
    {
      "locale": "en-US",
      "text": "<p>If you are 18 years or older and have ever been a patient at our healthcare organization, including Hospital, Clinic, Laboratory and Radiology, or other department, we may already have a medical record for you. Select **Yes** to complete the enrollment process before accessing our On Demand Video Visit service. If you have never been a patient at any of our facilities, select **No**.</p><p>If you select **Yes**, you will be directed to a self-enrollment process to link your portal account to your medical record. If enrollment succeeds, relaunch the On Demand Video Visit service from the home page. If enrollment is not completed, return to the home page and restart the On Demand Video Visit Service and select **No** when reaching this page./p><p>If you select **No**, you will be enrolled for access to our On Demand Video Visit service.</p>"
    }
  ]
}

GET /consumer-enrollment-configurations/{configurationId}

Retrieves the consumer enrollment configuration for this tenant and given ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Consumer Enrollment Configuration	ConsumerEnrollmentConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create a Consumer Enrollment Site 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/patient-portal-application/v1/consumer-enrollment-site-configurations', headers: headers, body: {"domainUri":"cernerdemo.patientportal.us.healtheintent.com","enrollmentConfiguration":{"id":"ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-site-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domainUri":"cernerdemo.patientportal.us.healtheintent.com","enrollmentConfiguration":{"id":"ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e"}}

{
  "id": "4faff4ea-5c0e-4da4-84a1-b4e6ce0fb031",
  "domainUri": "cernerdemo.patientportal.us.healtheintent.com",
  "enrollmentConfiguration": {
    "id": "ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e",
    "fpaPoolCode": 977272694,
    "messagingAliasPoolCode": 36701402,
    "millenniumDataPartitionId": "511d71b2-c065-4799-a0e4-7039086f95d3",
    "isMillenniumRelationship": true,
    "usesHealthelifePortal": true,
    "existingPatientWorkflowEnabled": true,
    "previousCareReceivedPromptTitle": null,
    "previousCareReceivedPromptDescription": null
  }
}

POST /consumer-enrollment-site-configurations

Creates a consumer enrollment site configuration for this tenant.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	Create a Consumer Enrollment Site Configuration	ConsumerEnrollmentSiteConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Retrieve a List of Consumer Enrollment Site 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/patient-portal-application/v1/consumer-enrollment-site-configurations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "4faff4ea-5c0e-4da4-84a1-b4e6ce0fb031",
      "domainUri": "cernerdemo.patientportal.us.healtheintent.com",
      "enrollmentConfiguration": {
        "id": "ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e",
        "fpaPoolCode": 977272694,
        "messagingAliasPoolCode": 36701402,
        "millenniumDataPartitionId": "511d71b2-c065-4799-a0e4-7039086f95d3",
        "isMillenniumRelationship": true,
        "usesHealthelifePortal": true,
        "existingPatientWorkflowEnabled": true,
        "previousCareReceivedPromptTitle": null,
        "previousCareReceivedPromptDescription": null
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-site-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-site-configurations?offset=0&limit=20"
}

GET /consumer-enrollment-site-configurations

Retrieves a list of consumer enrollment site configurations for a given tenant.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domainUri	query	string	false	N/A	No description	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a List of Consumer Enrollment Site Configurations	ConsumerEnrollmentSiteConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Single Consumer Enrollment Site Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-site-configurations/{siteConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-site-configurations/{siteConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /consumer-enrollment-site-configurations/{siteConfigurationId}

Deletes the consumer enrollment site configuration for this tenant and given ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Delete a Single Consumer Enrollment Site Configuration	None
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Update a Single Consumer Enrollment Site 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/patient-portal-application/v1/consumer-enrollment-site-configurations/{siteConfigurationId}', headers: headers, body: {"domainUri":"cernerdemo.patientportal.us.healtheintent.com","enrollmentConfiguration":{"id":"ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/consumer-enrollment-site-configurations/{siteConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domainUri":"cernerdemo.patientportal.us.healtheintent.com","enrollmentConfiguration":{"id":"ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e"}}

PUT /consumer-enrollment-site-configurations/{siteConfigurationId}

Updates the consumer enrollment site configuration for this tenant and given ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
204	No Content	Update a Single Consumer Enrollment Site Configuration	None
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a Single Consumer Enrollment Site 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/patient-portal-application/v1/consumer-enrollment-site-configurations/{siteConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


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

{
  "id": "4faff4ea-5c0e-4da4-84a1-b4e6ce0fb031",
  "domainUri": "cernerdemo.patientportal.us.healtheintent.com",
  "enrollmentConfiguration": {
    "id": "ae0fb031-5c0e-4da4-84a1-b4e6c4faff4e",
    "fpaPoolCode": 977272694,
    "messagingAliasPoolCode": 36701402,
    "millenniumDataPartitionId": "511d71b2-c065-4799-a0e4-7039086f95d3",
    "isMillenniumRelationship": true,
    "usesHealthelifePortal": true,
    "existingPatientWorkflowEnabled": true,
    "previousCareReceivedPromptTitle": null,
    "previousCareReceivedPromptDescription": null
  }
}

GET /consumer-enrollment-site-configurations/{siteConfigurationId}

Retrieves the consumer enrollment site configuration for this tenant and given ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	Retrieve a Single Consumer Enrollment Site Configuration	ConsumerEnrollmentSiteConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Allergies Data Source Configurations

Allergies data source configurations allow you to select allergies data from either Health Data Intelligence Longitudinal Record or Cerner Millennium for an application experience domain. You can also delete the configuration if it is no longer required.

Retrieve a List of HealtheLife Allergies Data Source 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/patient-portal-application/v1/allergies/data-source-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/data-source-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "dataSource": "HEALTHEINTENT",
      "applicationExperienceDomain": "testapp.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/data-source-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/data-source-configurations?offset=0&limit=20"
}

GET /allergies/data-source-configurations

Retrieves a list of all the HealtheLife allergies data source configurations that are paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife data source configurations belong.	-
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	A collection of data source configurations.	DataSourceConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Data Source 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/patient-portal-application/v1/allergies/data-source-configurations', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/data-source-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "dataSource": "HEALTHEINTENT",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /allergies/data-source-configurations

Creates a HealtheLife data source configuration by associating the domain with the given data source configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The data source configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_DataSourceConfiguration
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Allergies Data Source Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /allergies/data-source-configurations/{id}

Deletes the HealtheLife allergies data source configuration with the given data source configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-

Response Statuses

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

Update a HealtheLife Allergies Data Source 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/patient-portal-application/v1/allergies/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /allergies/data-source-configurations/{id}

Updates the HealtheLife allergies data source configuration with the given data source configuration ID. You cannot update the domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-
body	body	putAllergiesDataSourceConfigurations	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

Retrieve a Single HealtheLife Allergies Data Source 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/patient-portal-application/v1/allergies/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "dataSource": "HEALTHEINTENT",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /allergies/data-source-configurations/{id}

Retrieves the HealtheLife allergies data source configuration with the given data source configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A data source configuration.	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_DataSourceConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Adolescent Age Range Configuration

The Adolescent Age Range end point allows tenants to configure the following items:

Adolescent Age Range Definition: Allows tenants to create, retrieve, and delete the adolescent age range.
Adolescent Age Range Configuration: Allows tenants to configure the application experience domain to the adolescent age range. This includes storing, updating, and deleting the adolescent age range association with the application experience domain.

Delete an Adolescent Age Range 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/patient-portal-application/v1/adolescent-age-range-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /adolescent-age-range-definitions/{adolescentAgeRangeDefinitionId}

Deletes a specific adolescent age range definition. An adolescent age range definition cannot be deleted if it is associated with an application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentAgeRangeDefinitionId	path	string	true	N/A	The unique ID of adolescent age range definition associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Single Adolescent Age Range 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/patient-portal-application/v1/adolescent-age-range-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "minimumAge": 0,
  "maximumAge": 18
}

GET /adolescent-age-range-definitions/{adolescentAgeRangeDefinitionId}

Retrieves a single adolescent age range definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentAgeRangeDefinitionId	path	string	true	N/A	The unique ID of adolescent age range definition associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a List of Adolescent Age Range 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/patient-portal-application/v1/adolescent-age-range-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "minimumAge": 0,
      "maximumAge": 18
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-definitions?offset=0&limit=20"
}

GET /adolescent-age-range-definitions

Retrieves a list of adolescent age range definitions.

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

Create an Adolescent Age Range 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/patient-portal-application/v1/adolescent-age-range-definitions', headers: headers, body: {"minimumAge":0,"maximumAge":18}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"minimumAge":0,"maximumAge":18}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "minimumAge": 0,
  "maximumAge": 18
}

POST /adolescent-age-range-definitions

Creates a new instance of an adolescent age range configuration.

Parameters

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

Response Statuses

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

Update an Adolescent Age Range 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/patient-portal-application/v1/adolescent-age-range-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"adolescentAgeRangeDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"adolescentAgeRangeDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /adolescent-age-range-configurations/{adolescentAgeRangeConfigurationId}

Updates a specific adolescent age range configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentAgeRangeConfigurationId	path	string	true	N/A	The unique ID of the adolescent age range configuration associated with the Health Data Intelligence tenant.	-
body	body	putAdolescentAgeRangeConfigurations	true	N/A	No description	-

Response Statuses

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

Delete an Adolescent Age Range Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /adolescent-age-range-configurations/{adolescentAgeRangeConfigurationId}

Deletes a specific adolescent age range configuration. An adolescent age range configuration cannot be deleted if it is associated with an application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentAgeRangeConfigurationId	path	string	true	N/A	The unique ID of the adolescent age range configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Single Adolescent Age Range 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/patient-portal-application/v1/adolescent-age-range-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "adolescentAgeRange": {
    "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
    "minimumAge": 0,
    "maximumAge": 18
  }
}

GET /adolescent-age-range-configurations/{adolescentAgeRangeConfigurationId}

Retrieves a single adolescent age range configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentAgeRangeConfigurationId	path	string	true	N/A	The unique ID of the adolescent age range configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain the tenant ID belongs to.	-

Response Statuses

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

Retrieve a List of Adolescent Age Range 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/patient-portal-application/v1/adolescent-age-range-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "adolescentAgeRange": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "minimumAge": 0,
        "maximumAge": 18
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-configurations?offset=0&limit=20"
}

GET /adolescent-age-range-configurations

Retrieves a list of adolescent age range configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain the tenant ID belongs to.	-
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	OK	GetAdolescentConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Adolescent Age Range 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/patient-portal-application/v1/adolescent-age-range-configurations', headers: headers, body: {"adolescentAgeRangeDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/adolescent-age-range-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"adolescentAgeRangeDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "adolescentAgeRangeDefinitionId": "262038ed-c304-4737-93d9-55615b6a1cd5"
}

POST /adolescent-age-range-configurations

Creates a new instance of an adolescent age range configuration.

Parameters

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

Response Statuses

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

Documents Policy Text Configuration

Documents policy text configurations enable tenants to configure the following items:

Policy Text Definition: Enables you to add policies, a disclaimer, and other important information related to the documents page that is displayed to the consumer in a specific language and locale. This allows tenants to create only one policy text definition for a locale. The locale is the language code, for example, en-US.
Policy Text Configuration: Enables you to configure application experience domains for policy texts. This includes storing, updating, and deleting the policy text definitions associated with the application experience domain. Associating the policy text with the domain allows the text to be displayed in that domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.

Delete a Documents Policy Text 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/patient-portal-application/v1/documents-policy-texts/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-texts/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /documents-policy-texts/{policyTextId}

Deletes a specific policy text definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
policyTextId	path	string	true	N/A	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Single Documents Policy Text 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/patient-portal-application/v1/documents-policy-texts/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-texts/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

GET /documents-policy-texts/{policyTextId}

Retrieves a single policy text definition for documents.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
policyTextId	path	string	true	N/A	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a List of Documents Policy Text 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/patient-portal-application/v1/documents-policy-texts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-texts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-texts?offset=0&limit=20"
}

GET /documents-policy-texts

Retrieves a list of policy text definitions for documents.

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

Create a Documents Policy Text 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/patient-portal-application/v1/documents-policy-texts', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

POST /documents-policy-texts

Creates a new policy text definition for documents.

Parameters

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

Response Statuses

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

Update a Documents Policy Text 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/patient-portal-application/v1/documents-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}

PUT /documents-policy-text-configurations/{policyTextConfigurationId}

Updates a policy text configuration for documents. You can only update the policy text ID, you cannot update the application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
policyTextConfigurationId	path	string	true	N/A	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
body	body	putDocumentsPolicyTextConfigurations	true	N/A	No description	-

Response Statuses

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

Delete a Documents Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /documents-policy-text-configurations/{policyTextConfigurationId}

Deletes a policy text configuration for documents.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
policyTextConfigurationId	path	string	true	N/A	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-

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

Retrieve a Single Documents Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyText": {
    "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
    "localeTexts": [
      {
        "locale": "en-US",
        "text": "Sample Policy Text."
      }
    ]
  }
}

GET /documents-policy-text-configurations/{policyTextConfigurationId}

Retrieves a specific policy text configuration for documents.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
policyTextConfigurationId	path	string	true	N/A	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
Accept-Language	header	string	false	en-US	The locale of the policy text.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single policy text configuration for documents.	PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_GetDocumentsPolicyTextConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Documents Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "policyText": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "localeTexts": [
          {
            "locale": "en-US",
            "text": "Sample Policy Text."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations?offset=0&limit=20"
}

GET /documents-policy-text-configurations

Retrieves a list of policy text configurations for documents.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the ID of the tenant’s environment.	-
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
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	A collection of policy text configurations for documents.	GetDocumentsPolicyTextConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Documents Policy Text 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/patient-portal-application/v1/documents-policy-text-configurations', headers: headers, body: {"policyTextId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyTextId": "262038ed-c304-4737-93d9-55615b6a1ce6"
}

POST /documents-policy-text-configurations

Creates a policy text configuration for documents.

Parameters

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

Response Statuses

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

Documents Adolescent Data Flag Configurations

Adolescent data flag configurations can be enabled or disabled to provide adolescent screening for the specified documents.

Delete an Adolescent Data Flag Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /documents-adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Deletes an adolescent data flag configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of an adolescent data flag configuration.	-

Response Statuses

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

Update an Adolescent Data Flag 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/patient-portal-application/v1/documents-adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}

PUT /documents-adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Updates an adolescent data flag configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of an adolescent data flag configuration.	-
body	body	putDocumentsAdolescentDataFlagConfigurations	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 Adolescent Data Flag 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/patient-portal-application/v1/documents-adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "enabled": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /documents-adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Retrieves a specified adolescent data flag configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of an adolescent data flag configuration.	-

Response Statuses

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

Retrieve a List of Adolescent Data Flag 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/patient-portal-application/v1/documents-adolescent-data-flag-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "testapp.com",
      "enabled": "true",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-adolescent-data-flag-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-adolescent-data-flag-configurations?offset=0&limit=20"
}

GET /documents-adolescent-data-flag-configurations

Retrieves a list of all the HealtheLife adolescent data flag configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	The ID for the environment of the tenant.	-
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	OK	DocumentsAdolescentDataFlagConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create an Adolescent Data Flag 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/patient-portal-application/v1/documents-adolescent-data-flag-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "enabled": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /documents-adolescent-data-flag-configurations

Creates a new adolescent data flag configuration.

Parameters

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

Response Statuses

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

Documents Configurations

Documents configurations allow tenants to configure the following items:

Documents Definition: Allows tenants to define the attributes of the document. These attributes define how and when the document will be displayed in the portal for the consumer. These attributes include the event set name which identifies a document, the start date for displaying the documents, and attributes that indicate whether documents with a status of unauthenticated, transcribed, or in progress are displayed in the portal. A document definition can only be deleted if it is not configured with an application experience domain.
Documents Configuration: Allows tenants to associate an application experience domain with the document definition. This includes storing, updating, and deleting the document definition associated with the application experience domain. One document definition can be configured with multiple application experience domains.

Delete a Documents Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /documents-configurations/{documentsConfigurationId}

Deletes a specified documents configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
documentsConfigurationId	path	string	true	N/A	The unique ID of the documents configuration associated with the Health Data Intelligence tenant and domain.	-

Response Statuses

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

Update a Documents 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/patient-portal-application/v1/documents-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","documentDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","documentDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}

PUT /documents-configurations/{documentsConfigurationId}

Updates a documents configuration. Only the ID is updated, you cannot update the domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
documentsConfigurationId	path	string	true	N/A	The unique ID of the documents configuration associated with the Health Data Intelligence tenant and domain.	-
body	body	putDocumentsConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Documents Configuration


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Content-Type: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "documentDefinition": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "dataSource": "MILLENNIUM",
    "displayStartDate": "23-01-2021",
    "displayUnauthenticated": "false",
    "displayTranscribed": "false",
    "displayInProgress": "false",
    "isDocumentsEnabled": "false",
    "categories": [
      {
        "name": "IQ Health Documents",
        "publishDelayHours": 0
      }
    ]
  }
}

GET /documents-configurations/{documentsConfigurationId}

Retrieves a single documents configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
documentsConfigurationId	path	string	true	N/A	The unique ID of the documents configuration associated with the Health Data Intelligence tenant and domain.	-
Content-Type	header	string	false	N/A	The format of the request and response data.	-
applicationExperienceDomain	query	string	false	N/A	The ID of the environment associated with the tenant.	-

Response Statuses

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

Retrieve a List of Documents 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/patient-portal-application/v1/documents-configurations', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "documentDefinition": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "dataSource": "MILLENNIUM",
        "displayStartDate": "23-01-2021",
        "displayUnauthenticated": "false",
        "displayTranscribed": "false",
        "displayInProgress": "false",
        "isDocumentsEnabled": "false",
        "categories": [
          {
            "name": "IQ Health Documents",
            "publishDelayHours": 0
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-configurations?offset=0&limit=20"
}

GET /documents-configurations

Retrieves a list of documents configurations.

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

Create a Documents 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/patient-portal-application/v1/documents-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","documentDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","documentDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "documentDefinitionId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /documents-configurations

Creates a new documents configuration.

Parameters

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

Response Statuses

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

Delete a Documents 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/patient-portal-application/v1/documents-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /documents-definitions/{documentsDefinitionId}

Deletes a specified documents definition. You cannot delete a documents definition if it is associated with an application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
documentsDefinitionId	path	string	true	N/A	The unique ID of the documents definition associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Single Documents 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/patient-portal-application/v1/documents-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "dataSource": "MILLENNIUM",
  "displayStartDate": "23-01-2021",
  "displayUnauthenticated": "false",
  "displayTranscribed": "false",
  "displayInProgress": "false",
  "isDocumentsEnabled": "false",
  "categories": [
    {
      "name": "IQ Health Documents",
      "publishDelayHours": 0
    }
  ]
}

GET /documents-definitions/{documentsDefinitionId}

Retrieves a single documents definition.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
documentsDefinitionId	path	string	true	N/A	The unique ID of the documents definition associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a List of Documents 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/patient-portal-application/v1/documents-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "dataSource": "MILLENNIUM",
      "displayStartDate": "23-01-2021",
      "displayUnauthenticated": "false",
      "displayTranscribed": "false",
      "displayInProgress": "false",
      "isDocumentsEnabled": "false",
      "categories": [
        {
          "name": "IQ Health Documents",
          "publishDelayHours": 0
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-definitions?offset=0&limit=20"
}

GET /documents-definitions

Retrieves a list of documents definitions.

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

Create a Documents 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/patient-portal-application/v1/documents-definitions', headers: headers, body: {"dataSource":"MILLENNIUM","displayStartDate":"23-01-2021","displayUnauthenticated":"false","displayTranscribed":"false","displayInProgress":"false","isDocumentsEnabled":"false","categories":[{"name":"IQ Health Documents","publishDelayHours":0}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"dataSource":"MILLENNIUM","displayStartDate":"23-01-2021","displayUnauthenticated":"false","displayTranscribed":"false","displayInProgress":"false","isDocumentsEnabled":"false","categories":[{"name":"IQ Health Documents","publishDelayHours":0}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "dataSource": "MILLENNIUM",
  "displayStartDate": "23-01-2021",
  "displayUnauthenticated": "false",
  "displayTranscribed": "false",
  "displayInProgress": "false",
  "isDocumentsEnabled": "false",
  "categories": [
    {
      "name": "IQ Health Documents",
      "publishDelayHours": 0
    }
  ]
}

POST /documents-definitions

Creates a documents definition.

Parameters

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

Response Statuses

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

Documents All Configurations

The documents all configurations endpoint allows you to retrieve a list of all of the configurations for documents associated with the specified application experience domain.

Retrieve a List of Documents Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-all-configurations',
  query: {
  'applicationExperienceDomain' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-all-configurations?applicationExperienceDomain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "policyTextConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "policyText": {
          "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
          "localeTexts": [
            {
              "locale": "en-US",
              "text": "Sample Policy Text."
            }
          ]
        }
      },
      "documentConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "documentDefinition": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "dataSource": "MILLENNIUM",
          "displayStartDate": "23-01-2021",
          "displayUnauthenticated": "false",
          "displayTranscribed": "false",
          "displayInProgress": "false",
          "isDocumentsEnabled": "false",
          "categories": [
            {
              "name": "IQ Health Documents",
              "publishDelayHours": 0
            }
          ]
        }
      },
      "adolescentDataFlagConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "testapp.com",
        "enabled": "true",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-all-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/documents-all-configurations?offset=0&limit=20"
}

GET /documents-all-configurations

Retrieve a list of all configurations for the documents feature in the specified application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	true	N/A	The ID for the environment of the tenant.	-
Accept-Language	header	string	false	en-US	The locale of the policy text.	-
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	OK	DocumentsAllConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Medications Cerner Millennium Medication Configuration

Cerner Millennium medication configurations allow tenants to configure the following items:

Cerner Millennium Medication Definitions: Allow tenants to define the following attributes for active medications:

Enable refills for Cerner Millennium medications.
Enable unlisted medications.
Enable multiple medication renewals in one request.

A Cerner Millennium medication definition can only be deleted if it is not configured with any application experience domain.

Cerner Millennium Medication Configurations: Allow tenants to configure an application experience domain to the Cerner Millennium medication definition. This includes storing, updating and deleting the Cerner Millennium medication definition association with the application experience domain. One Cerner Millennium medication definition can be configured to multiple application experience domain but an application experience domain cannot be configured to multiple Cerner Millennium medication definitions.

Retrieve a List of Cerner Millennium Medication 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/patient-portal-application/v1/medications/millennium/medication-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "enableMedRefills": "true",
      "enableUnlistedRenewals": "true",
      "enableMultRenewals": "true",
      "enableMedRenewals": "true",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-definitions?offset=0&limit=20"
}

GET /medications/millennium/medication-definitions

Retrieves a list of Cerner Millennium medication definitions for medications.

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	A collection of Cerner Millennium medication definitions.	MillMedDefinitions
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Cerner Millennium Medication 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/patient-portal-application/v1/medications/millennium/medication-definitions', headers: headers, body: {"enableMedRefills":"true","enableUnlistedRenewals":"true","enableMultRenewals":"true","enableMedRenewals":"true"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"enableMedRefills":"true","enableUnlistedRenewals":"true","enableMultRenewals":"true","enableMedRenewals":"true"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "enableMedRefills": "true",
  "enableUnlistedRenewals": "true",
  "enableMultRenewals": "true",
  "enableMedRenewals": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /medications/millennium/medication-definitions

Creates a Cerner Millennium medication definition for medications.

Parameters

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

Response Statuses

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

Delete a Cerner Millennium Medication 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/patient-portal-application/v1/medications/millennium/medication-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/millennium/medication-definitions/{medicationDefinitionId}

Deletes the Cerner Millennium medication definition with the given Cerner Millennium medication definition ID. If the Cerner Millennium medication definition is associated with a Cerner Millennium medication configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medicationDefinitionId	path	string	true	N/A	The unique ID of the Cerner Millennium medication definition associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Single Cerner Millennium Medication 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/patient-portal-application/v1/medications/millennium/medication-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "enableMedRefills": "true",
  "enableUnlistedRenewals": "true",
  "enableMultRenewals": "true",
  "enableMedRenewals": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /medications/millennium/medication-definitions/{medicationDefinitionId}

Retrieves a single Cerner Millennium medication definition for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medicationDefinitionId	path	string	true	N/A	The unique ID of the Cerner Millennium medication definition associated with the Health Data Intelligence tenant.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Cerner Millennium medication definition.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillMedDefinition
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Cerner Millennium Medication 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/patient-portal-application/v1/medications/millennium/medication-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "testapp.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "millMedicationDefinition": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "enableMedRefills": "true",
        "enableUnlistedRenewals": "true",
        "enableMultRenewals": "true",
        "enableMedRenewals": "true",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-configurations?offset=0&limit=20"
}

GET /medications/millennium/medication-configurations

Retrieves a list of Cerner Millennium medication configurations for medications that is paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of Cerner Millennium medication configurations.	GetMillMedConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Cerner Millennium Medication 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/patient-portal-application/v1/medications/millennium/medication-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","medicationDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","medicationDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "medicationDefinitionId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /medications/millennium/medication-configurations

Creates a Cerner Millennium medication configuration for medications.

Parameters

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

Response Statuses

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

Delete a Cerner Millennium Medication Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/millennium/medication-configurations/{medConfigurationId}

Deletes a Cerner Millennium medication configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medConfigurationId	path	string	true	N/A	The unique ID of the Cerner Millennium medication configuration associated with the Health Data Intelligence tenant and domain.	-

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 Cerner Millennium Medication 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/patient-portal-application/v1/medications/millennium/medication-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","medicationDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","medicationDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}

PUT /medications/millennium/medication-configurations/{medConfigurationId}

Updates a Cerner Millennium medication configuration for medications. This only updates the Cerner Millennium medication ID. You cannot update the application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medConfigurationId	path	string	true	N/A	The unique ID of the Cerner Millennium medication configuration associated with the Health Data Intelligence tenant and domain.	-
body	body	putMedicationsMillenniumMedicationConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Cerner Millennium Medication 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/patient-portal-application/v1/medications/millennium/medication-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/medication-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "millMedicationDefinition": {
    "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
    "enableMedRefills": "true",
    "enableUnlistedRenewals": "true",
    "enableMultRenewals": "true",
    "enableMedRenewals": "true",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z"
  }
}

GET /medications/millennium/medication-configurations/{medConfigurationId}

Retrieves a single Cerner Millennium medication configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medConfigurationId	path	string	true	N/A	The unique ID of the Cerner Millennium medication configuration associated with the Health Data Intelligence tenant and domain.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Cerner Millennium medication configuration.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetMillMedConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Medications Comprehensive Medication Configuration

Comprehensive medication configurations allow tenants to configure the following items:

Comprehensive Medication Definitions: Allow tenants to define the following attributes for active medications:

Enable refills for comprehensive medications.
Enable unlisted medications.
Enable multiple medication renewals in one request.

A comprehensive medication definition can only be deleted if it is not configured with any application experience domain.

Comprehensive Medication Configurations: Allow tenants to configure an application experience domain to the comprehensive medication definition. This includes storing, updating and deleting the comprehensive medication definition association with the application experience domain. One comprehensive medication definition can be configured to multiple application experience domain but an application experience domain cannot be configured to multiple comprehensive medication definitions.

Retrieve a List of Comprehensive Medication 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/patient-portal-application/v1/medications/comprehensive/medication-definitions', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "enableMedRefills": "true",
      "enableUnlistedRenewals": "true",
      "enableMultRenewals": "true",
      "educationContentUrl": "https://medicationsconfig.learnmore.com",
      "enableMedRenewals": "true",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-definitions?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-definitions?offset=0&limit=20"
}

GET /medications/comprehensive/medication-definitions

Retrieves a list of comprehensive medication definitions for medications.

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	A collection of comprehensive medication definitions.	CompMedDefinitions
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Comprehensive Medication 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/patient-portal-application/v1/medications/comprehensive/medication-definitions', headers: headers, body: {"enableMedRefills":"true","enableUnlistedRenewals":"true","enableMultRenewals":"true","educationContentUrl":"https://medicationsconfig.learnmore.com","enableMedRenewals":"true"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"enableMedRefills":"true","enableUnlistedRenewals":"true","enableMultRenewals":"true","educationContentUrl":"https://medicationsconfig.learnmore.com","enableMedRenewals":"true"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "enableMedRefills": "true",
  "enableUnlistedRenewals": "true",
  "enableMultRenewals": "true",
  "educationContentUrl": "https://medicationsconfig.learnmore.com",
  "enableMedRenewals": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /medications/comprehensive/medication-definitions

Creates a comprehensive medication definition for medications.

Parameters

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

Response Statuses

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

Delete a Comprehensive Medication 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/patient-portal-application/v1/medications/comprehensive/medication-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/comprehensive/medication-definitions/{medicationDefinitionId}

Deletes the comprehensive medication definition with the given comprehensive medication definition ID. If the comprehensive medication definition is associated with a comprehensive medication configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medicationDefinitionId	path	string	true	N/A	The unique ID of the comprehensive medication definition associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Single Comprehensive Medication 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/patient-portal-application/v1/medications/comprehensive/medication-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "enableMedRefills": "true",
  "enableUnlistedRenewals": "true",
  "enableMultRenewals": "true",
  "educationContentUrl": "https://medicationsconfig.learnmore.com",
  "enableMedRenewals": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /medications/comprehensive/medication-definitions/{medicationDefinitionId}

Retrieves a single comprehensive medication definition for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medicationDefinitionId	path	string	true	N/A	The unique ID of the comprehensive medication definition associated with the Health Data Intelligence tenant.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single comprehensive medication definition.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompMedDefinition
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Comprehensive Medication 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/patient-portal-application/v1/medications/comprehensive/medication-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "testapp.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "compMedicationDefinition": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "enableMedRefills": "true",
        "enableUnlistedRenewals": "true",
        "enableMultRenewals": "true",
        "educationContentUrl": "https://medicationsconfig.learnmore.com",
        "enableMedRenewals": "true",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-configurations?offset=0&limit=20"
}

GET /medications/comprehensive/medication-configurations

Retrieves a list of comprehensive medication configurations for medications that are paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of comprehensive medication configurations.	GetCompMedConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Comprehensive Medication 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/patient-portal-application/v1/medications/comprehensive/medication-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","medicationDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","medicationDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "medicationDefinitionId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /medications/comprehensive/medication-configurations

Creates a comprehensive medication configuration for medications.

Parameters

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

Response Statuses

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

Delete a Comprehensive Medication Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/comprehensive/medication-configurations/{medConfigurationId}

Deletes a comprehensive medication configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medConfigurationId	path	string	true	N/A	The unique ID of the comprehensive medication configuration associated with the Health Data Intelligence tenant and domain.	-

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 Comprehensive Medication 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/patient-portal-application/v1/medications/comprehensive/medication-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","medicationDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","medicationDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}

PUT /medications/comprehensive/medication-configurations/{medConfigurationId}

Updates a comprehensive medication configuration for medications. This only updates the comprehensive medication ID. You cannot update the application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medConfigurationId	path	string	true	N/A	The unique ID of the comprehensive medication configuration associated with the Health Data Intelligence tenant and domain.	-
body	body	putMedicationsComprehensiveMedicationConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Comprehensive Medication 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/patient-portal-application/v1/medications/comprehensive/medication-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/medication-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "compMedicationDefinition": {
    "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
    "enableMedRefills": "true",
    "enableUnlistedRenewals": "true",
    "enableMultRenewals": "true",
    "educationContentUrl": "https://medicationsconfig.learnmore.com",
    "enableMedRenewals": "true",
    "createdAt": "2020-01-20T05:40:02.000Z",
    "updatedAt": "2020-01-20T05:40:02.000Z"
  }
}

GET /medications/comprehensive/medication-configurations/{medConfigurationId}

Retrieves a single comprehensive medication configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
medConfigurationId	path	string	true	N/A	The unique ID of the comprehensive medication configuration associated with the Health Data Intelligence tenant and domain.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single comprehensive medication configuration.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetCompMedConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Medications Knowledge Base Configuration

Knowledge base configurations allow tenants to configure the following items:

Knowledge Bases: Allows you to edit knowledge bases for a given Health Data Intelligence tenant.

Knowledge Base Configurations: Allows you to edit knowledge base configurations for a given Health Data Intelligence tenant and domain.

Retrieve a List of Knowledge Bases


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/patient-portal-application/v1/medications/knowledge-bases', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-bases \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeCodes": [
        {
          "locale": "en-US",
          "code": "151"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-bases?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-bases?offset=0&limit=20"
}

GET /medications/knowledge-bases

Retrieves a list of knowledge bases for medications.

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	A collection of knowledge bases.	KnowledgeBases
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Knowledge Base




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/patient-portal-application/v1/medications/knowledge-bases', headers: headers, body: {"localeCodes":[{"locale":"en-US","code":"151"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-bases \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeCodes":[{"locale":"en-US","code":"151"}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeCodes": [
    {
      "locale": "en-US",
      "code": "151"
    }
  ]
}

POST /medications/knowledge-bases

Creates a knowledge base for medications.

Parameters

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

Response Statuses

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

Delete a Knowledge Base


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/patient-portal-application/v1/medications/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/knowledge-bases/{id}

Deletes a knowledge base with the given knowledge base ID. If the knowledge base is associated with a knowledge base configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base.	-

Response Statuses

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

Retrieve a Single Knowledge Base


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/patient-portal-application/v1/medications/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-bases/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeCodes": [
    {
      "locale": "en-US",
      "code": "151"
    }
  ]
}

GET /medications/knowledge-bases/{id}

Retrieves a single knowledge base for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single knowledge base.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_KnowledgeBase
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Knowledge Base Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "knowledgeBase": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "facilityCd": "151",
        "primaryCriteriaCd": "123",
        "localeCodes": [
          {
            "locale": "en-US",
            "code": "151"
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations?offset=0&limit=20"
}

GET /medications/knowledge-base-configurations

Retrieves a list of knowledge base configurations for medications that are paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the knowledge base.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of knowledge base configurations.	GetKnowledgeBaseConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Medications Knowledge Base 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/patient-portal-application/v1/medications/knowledge-base-configurations', headers: headers, body: {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "knowledgeBaseId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /medications/knowledge-base-configurations

Creates a knowledge base configuration for medications.

Parameters

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

Response Statuses

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

Delete a Knowledge Base Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/knowledge-base-configurations/{id}

Deletes a knowledge base configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base configuration.	-

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 Knowledge Base 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/patient-portal-application/v1/medications/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"knowledgeBaseId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /medications/knowledge-base-configurations/{id}

Updates a knowledge base configuration for medications. This only updates the knowledge base ID. You cannot update the application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base configuration.	-
body	body	putMedicationsKnowledgeBaseConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Knowledge Base Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/knowledge-base-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "knowledgeBase": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "facilityCd": "151",
    "primaryCriteriaCd": "123",
    "localeCodes": [
      {
        "locale": "en-US",
        "code": "151"
      }
    ]
  }
}

GET /medications/knowledge-base-configurations/{id}

Retrieves a single knowledge base configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the knowledge base configuration.	-
Accept-Language	header	string	false	en-US	The locale of the knowledge base.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single knowledge base configuration.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetKnowledgeBaseConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Medications Cerner Millennium Policy Text Configuration

Cerner Millennium policy text configurations allow tenants to configure the following items:

Cerner Millennium Policy Texts: Allows you to edit a policy text associated with an Cerner Millennium medication for a given Health Data Intelligence tenant.

Cerner Millennium Policy Text Configurations: Allows you to edit policy text configurations associated with a Cerner Millennium medication for a given Health Data Intelligence tenant and domain.

Retrieve a List of Cerner Millennium Policy Texts


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/patient-portal-application/v1/medications/millennium/policy-texts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeTexts": [
        {
          "locale": "en-US",
          "text": "Sample *Cerner Millennium* Policy Text."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-texts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-texts?offset=0&limit=20"
}

GET /medications/millennium/policy-texts

Retrieves a list of Cerner Millennium policy texts for medications.

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	A collection of Cerner Millennium policy texts.	MillPolicyTexts
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Cerner Millennium Policy Text




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/patient-portal-application/v1/medications/millennium/policy-texts', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample *Cerner Millennium* Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample *Cerner Millennium* Policy Text."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample *Cerner Millennium* Policy Text."
    }
  ]
}

POST /medications/millennium/policy-texts

Creates a Cerner Millennium policy text for medications.

Parameters

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

Response Statuses

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

Delete a Cerner Millennium Policy Text


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/patient-portal-application/v1/medications/millennium/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/millennium/policy-texts/{id}

Deletes the Cerner Millennium policy text with the given Cerner Millennium policy text ID. If the Cerner Millennium policy text is associated with a Cerner Millennium policy text configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the Cerner Millennium policy text.	-

Response Statuses

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

Retrieve a Single Cerner Millennium Policy Text


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/patient-portal-application/v1/medications/millennium/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample *Cerner Millennium* Policy Text."
    }
  ]
}

GET /medications/millennium/policy-texts/{id}

Retrieves a single Cerner Millennium policy text for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the Cerner Millennium policy text.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Cerner Millennium policy text.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillPolicyText
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Cerner Millennium Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "policyText": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeTexts": [
          {
            "locale": "en-US",
            "text": "Sample *Cerner Millennium* Policy Text."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations?offset=0&limit=20"
}

GET /medications/millennium/policy-text-configurations

Retrieves a list of Cerner Millennium policy text configurations for medications that is paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the Cerner Millennium policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of Cerner Millennium policy text configurations.	GetMillPolicyTextConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Cerner Millennium Policy Text 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/patient-portal-application/v1/medications/millennium/policy-text-configurations', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyTextId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /medications/millennium/policy-text-configurations

Creates a Cerner Millennium policy text configuration for medications.

Parameters

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

Response Statuses

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

Delete a Cerner Millennium Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/millennium/policy-text-configurations/{id}

Deletes a Cerner Millennium policy text configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of a Cerner Millennium policy text configuration.	-

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 Cerner Millennium Policy Text 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/patient-portal-application/v1/medications/millennium/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /medications/millennium/policy-text-configurations/{id}

Updates a Cerner Millennium policy text configuration for medications. This only updates the policy text ID. You cannot update the application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of a Cerner Millennium policy text configuration.	-
body	body	putMedicationsMillenniumPolicyTextConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Cerner Millennium Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/millennium/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyText": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeTexts": [
      {
        "locale": "en-US",
        "text": "Sample *Cerner Millennium* Policy Text."
      }
    ]
  }
}

GET /medications/millennium/policy-text-configurations/{id}

Retrieves a single Cerner Millennium policy text configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of a Cerner Millennium policy text configuration.	-
Accept-Language	header	string	false	en-US	The locale of the Cerner Millennium policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Cerner Millennium policy text.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetMillPolicyTextConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Medications Comprehensive Policy Text Configuration

Comprehensive policy text configurations allow tenants to configure the following items:

Comprehensive Policy Texts: Allows you to edit a policy text associated with a comprehensive medication for a given Health Data Intelligence tenant.

Comprehensive Policy Text Configurations: Allows you to edit policy text configurations associated with a comprehensive medication for a given Health Data Intelligence tenant and domain.

Retrieve a List of Comprehensive Policy Texts


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/patient-portal-application/v1/medications/comprehensive/policy-texts', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeTexts": [
        {
          "locale": "en-US",
          "text": "Sample Comprehensive Policy Text."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-texts?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-texts?offset=0&limit=20"
}

GET /medications/comprehensive/policy-texts

Retrieves a list of comprehensive policy texts for medications.

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	A collection of comprehensive policy texts.	CompPolicyTexts
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Comprehensive Policy Text




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/patient-portal-application/v1/medications/comprehensive/policy-texts', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample Comprehensive Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-texts \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample Comprehensive Policy Text."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Comprehensive Policy Text."
    }
  ]
}

POST /medications/comprehensive/policy-texts

Creates a comprehensive policy text for medications.

Parameters

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

Response Statuses

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

Delete a Comprehensive Policy Text


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/patient-portal-application/v1/medications/comprehensive/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/comprehensive/policy-texts/{id}

Deletes the comprehensive policy text with the given comprehensive policy text ID. If the comprehensive policy text is associated with a comprehensive policy text configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the comprehensive policy text.	-

Response Statuses

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

Retrieve a Single Comprehensive Policy Text


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/patient-portal-application/v1/medications/comprehensive/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-texts/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample Comprehensive Policy Text."
    }
  ]
}

GET /medications/comprehensive/policy-texts/{id}

Retrieves a single comprehensive policy text for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the comprehensive policy text.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single comprehensive policy text.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompPolicyText
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Comprehensive Policy Text Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "policyText": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeTexts": [
          {
            "locale": "en-US",
            "text": "Sample Comprehensive Policy Text."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations?offset=0&limit=20"
}

GET /medications/comprehensive/policy-text-configurations

Retrieves a list of comprehensive policy text configurations for medications that are paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the comprehensive policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of comprehensive policy text configurations.	GetCompPolicyTextConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Comprehensive Policy Text 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/patient-portal-application/v1/medications/comprehensive/policy-text-configurations', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyTextId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /medications/comprehensive/policy-text-configurations

Creates a comprehensive policy text configuration for medications.

Parameters

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

Response Statuses

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

Delete a Comprehensive Policy Text Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/comprehensive/policy-text-configurations/{id}

Deletes a comprehensive policy text configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of a comprehensive policy text configuration.	-

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 Comprehensive Policy Text 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/patient-portal-application/v1/medications/comprehensive/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /medications/comprehensive/policy-text-configurations/{id}

Updates a comprehensive policy text configuration for medications. This only updates the policy text ID. You cannot update the application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of a comprehensive policy text configuration.	-
body	body	putMedicationsComprehensivePolicyTextConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Comprehensive Policy Text Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/comprehensive/policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "policyText": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeTexts": [
      {
        "locale": "en-US",
        "text": "Sample Comprehensive Policy Text."
      }
    ]
  }
}

GET /medications/comprehensive/policy-text-configurations/{id}

Retrieves a single comprehensive policy text configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of a comprehensive policy text configuration.	-
Accept-Language	header	string	false	en-US	The locale of the comprehensive policy text.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single comprehensive policy text.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetCompPolicyTextConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Medications Adolescent Data Flag Configuration

Medications adolescent data flag configurations allow tenants to configure the adolescent data flag for a Health Data Intelligence tenant and application experience domain.

Retrieve a List of HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/medications/adolescent-data-flag-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "testapp.com",
      "enabled": "true",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/adolescent-data-flag-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/adolescent-data-flag-configurations?offset=0&limit=20"
}

GET /medications/adolescent-data-flag-configurations

Retrieves a list of all the HealtheLife adolescent data flag configurations that are paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife adolescent data flag configurations belong.	-
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	A collection of adolescent data flag configurations.	AdolescentDataFlagConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/medications/adolescent-data-flag-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "enabled": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /medications/adolescent-data-flag-configurations

Creates a HealtheLife adolescent data flag configuration by associating the domain with the given adolescent data flag configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The adolescent data flag configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_AdolescentDataFlagConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Adolescent Data Flag Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Deletes the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-

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 HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/medications/adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}

PUT /medications/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Updates the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID. The domain cannot be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-
body	body	putMedicationsAdolescentDataFlagConfigurations	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 HealtheLife Adolescent Data Flag 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/patient-portal-application/v1/medications/adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/adolescent-data-flag-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "enabled": "true",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /medications/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}

Retrieves the HealtheLife medications adolescent data flag configuration with the given adolescent data flag configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adolescentDataFlagConfigurationId	path	string	true	N/A	The unique ID of the adolescent data flag configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single adolescent data flag configuration.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_AdolescentDataFlagConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Medications Data Source Configuration

Medications data source configurations allow you to configure the data source identifiers for U.S. Veterans Information Systems Technology and Architecture (VistA) and Cerner Millennium data sources.

Retrieve a List of HealtheLife Data Source 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/patient-portal-application/v1/medications/data-source-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/data-source-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "testapp.com",
      "dataSources": [
        {
          "type": "MILLENNIUM",
          "dataSourceIds": [
            "P1232321/R32321321/23231231",
            "P1232321/R32321321/23653476"
          ]
        }
      ],
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/data-source-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/data-source-configurations?offset=0&limit=20"
}

GET /medications/data-source-configurations

Retrieves a list of all the HealtheLife data source configurations that are paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the HealtheLife data source configurations belong.	-
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	A collection of data source configurations.	DataSourceConfigs
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a HealtheLife Data Source 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/patient-portal-application/v1/medications/data-source-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","dataSources":[{"type":"MILLENNIUM","dataSourceIds":["P1232321/R32321321/23231231","P1232321/R32321321/23653476"]}],"dataSourceIds":["P1232321/R32321321/23231231"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/data-source-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","dataSources":[{"type":"MILLENNIUM","dataSourceIds":["P1232321/R32321321/23231231","P1232321/R32321321/23653476"]}],"dataSourceIds":["P1232321/R32321321/23231231"]}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "dataSources": [
    {
      "type": "MILLENNIUM",
      "dataSourceIds": [
        "P1232321/R32321321/23231231",
        "P1232321/R32321321/23653476"
      ]
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /medications/data-source-configurations

Creates a HealtheLife data source configuration by associating the domain with the given data source configuration ID.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
201	Created	The data source configuration was created.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_DataSourceConfig
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a HealtheLife Data Source Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/data-source-configurations/{id}

Deletes the HealtheLife data source configuration with the given data source configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-

Response Statuses

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

Update a HealtheLife Data Source 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/patient-portal-application/v1/medications/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","dataSources":[{"type":"MILLENNIUM","dataSourceIds":["P1232321/R32321321/23231231","P1232321/R32321321/23653476"]}],"dataSourceIds":["P1232321/R32321321/23231231"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","dataSources":[{"type":"MILLENNIUM","dataSourceIds":["P1232321/R32321321/23231231","P1232321/R32321321/23653476"]}],"dataSourceIds":["P1232321/R32321321/23231231"]}

PUT /medications/data-source-configurations/{id}

Updates the HealtheLife data source configuration with the given data source configuration ID. The domain cannot be updated.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-
body	body	putMedicationsDataSourceConfigurations	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 HealtheLife Data Source 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/patient-portal-application/v1/medications/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/data-source-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "dataSources": [
    {
      "type": "MILLENNIUM",
      "dataSourceIds": [
        "P1232321/R32321321/23231231",
        "P1232321/R32321321/23653476"
      ]
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /medications/data-source-configurations/{id}

Retrieves the HealtheLife medications data source configuration with the given data source configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the data source configuration.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single data source configuration.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_DataSourceConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Medications Rule Management

Medications rule management allows tenants to create, retrieve, update and delete medication rule configurations which will be used to send renewal, refill and new medication requests from the patient portal. The rule defines a relation between a location ID and pool ID, with a user-defined name. These rules can be associated to a Health Data Intelligence tenant’s application experience domain through a configuration with a group ID.

Retrieve a List of Rule Groups


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/patient-portal-application/v1/medication-rule-groups', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "name": "VA Medical Center",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/rule-groups?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/rule-groups?offset=0&limit=20"
}

GET /medication-rule-groups

Retrieves a list of rule groups for medications.

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	A collection of rule groups.	RuleGroups
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Rule Group




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/patient-portal-application/v1/medication-rule-groups', headers: headers, body: {"name":"VA Medical Center"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-groups \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"VA Medical Center"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "name": "VA Medical Center",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /medication-rule-groups

Creates a rule group for medications.

Parameters

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

Response Statuses

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

Retrieve a Single Rule Group


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/patient-portal-application/v1/medication-rule-groups/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-groups/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "name": "VA Medical Center",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /medication-rule-groups/{ruleGroupId}

Retrieves a single rule group for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ruleGroupId	path	string	true	N/A	The unique ID for the rule group associated with the Health Data Intelligence tenantId	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Rule Group.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_RuleGroup
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Delete a Rule Group


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/patient-portal-application/v1/medication-rule-groups/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-groups/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medication-rule-groups/{ruleGroupId}

Deletes the rule group with the given rule group ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ruleGroupId	path	string	true	N/A	The unique ID for the rule group associated with the Health Data Intelligence tenantId	-

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

Retrieve a List of 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/patient-portal-application/v1/medication-rule-groups/{ruleGroupId}/medication-rules', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-groups/{ruleGroupId}/medication-rules \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "locationId": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "poolId": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "displayName": "VA Medical Center",
      "isDefaultPool": "true",
      "poolName": "Test Pool Name"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-groups/9b86e097-25e5-4d29-9c64-0f81c984b908/medication-rules?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-groups/9b86e097-25e5-4d29-9c64-0f81c984b908/medication-rules?offset=0&limit=20"
}

GET /medication-rule-groups/{ruleGroupId}/medication-rules

Retrieves a list of rules for medications. Supports pagination limit query param to be a maximum of 1000.

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.	-
locationId	query	array[string]	false	N/A	Filters the rules which contain the location IDs.	-
isDefaultPool	query	boolean	false	N/A	Filters the rules matching the criteria for default or not.	-
ruleGroupId	path	integer(int32)	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of rules.	Rules
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create 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/patient-portal-application/v1/medication-rule-groups/{ruleGroupId}/medication-rules', headers: headers, body: {"rules":[{"locationId":"262038ed-c304-4737-93d9-55615b6a1cd5","poolId":"262038ed-c304-4737-93d9-55615b6a1cd5","displayName":"VA Medical Center","isDefaultPool":"true","poolName":"Test Pool Name"}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-groups/{ruleGroupId}/medication-rules \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"rules":[{"locationId":"262038ed-c304-4737-93d9-55615b6a1cd5","poolId":"262038ed-c304-4737-93d9-55615b6a1cd5","displayName":"VA Medical Center","isDefaultPool":"true","poolName":"Test Pool Name"}]}

POST /medication-rule-groups/{ruleGroupId}/medication-rules

Create rules for medications. Supports bulk creation in multiple batches without overriding existing rules. A rule defines an association between location ID and a pool ID with a name.

Parameters

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

Response Statuses

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

Retrieve a List of Rule 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/patient-portal-application/v1/medication-rule-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "testapp.com",
      "ruleGroupId": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-configurations?offset=0&limit=20"
}

GET /medication-rule-configurations

Retrieves a list of rule configurations for medications.

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	Filters by the domain to which the tenant ID belongs.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of rule configurations.	RuleConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Rule 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/patient-portal-application/v1/medication-rule-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","ruleGroupId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","ruleGroupId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "ruleGroupId": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /medication-rule-configurations

Creates a rule configuration for medications. This endpoint configures a medication rule group with a domain.

Parameters

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

Response Statuses

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

Delete a Rule Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medication-rule-configurations/{ruleConfigurationId}

Deletes the rule configuration with the given rule configuration ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ruleConfigurationId	path	string	true	N/A	The unique ID for the rule configuration associated with the Health Data Intelligence tenantId	-

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 Medication Rule 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/patient-portal-application/v1/medication-rule-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","ruleGroupId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","ruleGroupId":"2bab765b-cbeb-40ef-b557-540ab3841cdf"}

PUT /medication-rule-configurations/{ruleConfigurationId}

Updates a rule configuration for medications. Only allows update of the rule group ID. The application experience domain is immutable.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ruleConfigurationId	path	string	true	N/A	The unique ID for the rule configuration associated with the Health Data Intelligence tenantId	-
body	body	putMedicationRuleConfigurations	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 Rule 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/patient-portal-application/v1/medication-rule-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medication-rule-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "testapp.com",
  "ruleGroupId": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /medication-rule-configurations/{ruleConfigurationId}

Retrieves a single rule configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
ruleConfigurationId	path	string	true	N/A	The unique ID for the rule configuration associated with the Health Data Intelligence tenantId	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single Rule Configuration.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_RuleConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Medications Renew Confirmation Message Configuration

Renew confirmation message configurations allow tenants to configure the following items:

Renew Confirmation Messages: Allows you to add or delete renew confirmation messages associated with a given Health Data Intelligence tenant.

Renew Confirmation Message Configurations: Allows you to add, edit, or delete the renew confirmation message configurations associated with a given Health Data Intelligence tenant and domain.

Retrieve a List of Renew Confirmation Message Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "renewConfirmationMessage": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeTexts": [
          {
            "locale": "en-US",
            "text": "Sample success message."
          }
        ]
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations?offset=0&limit=20"
}

GET /medications/renew-confirmation-message-configurations

Retrieves a list of renew confirmation message configurations for medications that is paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the renew confirmation message.	-
applicationExperienceDomain	query	string	false	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of renew confirmation message configurations.	GetRenewConfirmationMessageConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Renew Confirmation Message 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/patient-portal-application/v1/medications/renew-confirmation-message-configurations', headers: headers, body: {"renewConfirmationMessageId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"renewConfirmationMessageId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "renewConfirmationMessageId": "2bab765b-cbeb-40ef-b557-540ab3841cdf"
}

POST /medications/renew-confirmation-message-configurations

Creates a renew confirmation message configuration for medications.

Parameters

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

Response Statuses

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

Delete a Renew Confirmation Message Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/renew-confirmation-message-configurations/{id}

Deletes a renew confirmation message configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the renew confirmation message configuration.	-

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 Renew Confirmation Message 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/patient-portal-application/v1/medications/renew-confirmation-message-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"renewConfirmationMessageId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"renewConfirmationMessageId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}

PUT /medications/renew-confirmation-message-configurations/{id}

Updates a renew confirmation message configuration for medications. This only updates the renew confirmation message ID. You cannot update the application experience domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the renew confirmation message configuration.	-
body	body	putMedicationsRenewConfirmationMessageConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Renew Confirmation Message Configuration


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-message-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "renewConfirmationMessage": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeTexts": [
      {
        "locale": "en-US",
        "text": "Sample success message."
      }
    ]
  }
}

GET /medications/renew-confirmation-message-configurations/{id}

Retrieves a single renew confirmation message configuration for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the renew confirmation message configuration.	-
Accept-Language	header	string	false	en-US	The locale of the renew confirmation message.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single renew confirmation message.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetRenewConfirmationMessageConfiguration
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Renew Confirmation 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/patient-portal-application/v1/medications/renew-confirmation-messages', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-messages \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "localeTexts": [
        {
          "locale": "en-US",
          "text": "Sample success message."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-messages?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-messages?offset=0&limit=20"
}

GET /medications/renew-confirmation-messages

Retrieves a list of renew confirmation messages for medications.

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	A collection of renew confirmation messages.	RenewConfirmationMessages
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Renew Confirmation 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/patient-portal-application/v1/medications/renew-confirmation-messages', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample success message."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-messages \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample success message."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample success message."
    }
  ]
}

POST /medications/renew-confirmation-messages

Creates a renew confirmation message for medications.

Parameters

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

Response Statuses

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

Delete a Renew Confirmation Message


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/patient-portal-application/v1/medications/renew-confirmation-messages/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-messages/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /medications/renew-confirmation-messages/{id}

Deletes the renew confirmation message with the given renew confirmation message ID. If the renew confirmation message is associated with a renew confirmation message configuration, it cannot be deleted.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the renew confirmation message.	-

Response Statuses

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

Retrieve a Single Renew Confirmation 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/patient-portal-application/v1/medications/renew-confirmation-messages/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/renew-confirmation-messages/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "localeTexts": [
    {
      "locale": "en-US",
      "text": "Sample success message."
    }
  ]
}

GET /medications/renew-confirmation-messages/{id}

Retrieves a single renew confirmation message for medications.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
id	path	string	true	N/A	The unique ID of the renew confirmation message.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single renew confirmation message.	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_RenewConfirmationMessage
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Medications Configurations

Medications configurations allow you to retrieve all medication configurations.

Retrieve a List of Medications Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/configurations',
  query: {
  'applicationExperienceDomain' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/configurations?applicationExperienceDomain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "millPolicyTextConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "policyText": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "localeTexts": [
            {
              "locale": "en-US",
              "text": "Sample *Cerner Millennium* Policy Text."
            }
          ]
        }
      },
      "compPolicyTextConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "policyText": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "localeTexts": [
            {
              "locale": "en-US",
              "text": "Sample Comprehensive Policy Text."
            }
          ]
        }
      },
      "millMedConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "testapp.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "millMedicationDefinition": {
          "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
          "enableMedRefills": "true",
          "enableUnlistedRenewals": "true",
          "enableMultRenewals": "true",
          "enableMedRenewals": "true",
          "createdAt": "2020-01-20T05:40:02.000Z",
          "updatedAt": "2020-01-20T05:40:02.000Z"
        }
      },
      "compMedConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "testapp.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "compMedicationDefinition": {
          "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
          "enableMedRefills": "true",
          "enableUnlistedRenewals": "true",
          "enableMultRenewals": "true",
          "educationContentUrl": "https://medicationsconfig.learnmore.com",
          "enableMedRenewals": "true",
          "createdAt": "2020-01-20T05:40:02.000Z",
          "updatedAt": "2020-01-20T05:40:02.000Z"
        }
      },
      "knowledgeBaseConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "knowledgeBase": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "facilityCd": "151",
          "primaryCriteriaCd": "123",
          "localeCodes": [
            {
              "locale": "en-US",
              "code": "151"
            }
          ]
        }
      },
      "adolescentDataFlagConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "testapp.com",
        "enabled": "true",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      },
      "dataSourceConfiguration": {
        "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
        "applicationExperienceDomain": "testapp.com",
        "dataSources": [
          {
            "type": "MILLENNIUM",
            "dataSourceIds": [
              "P1232321/R32321321/23231231",
              "P1232321/R32321321/23653476"
            ]
          }
        ],
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z"
      },
      "renewConfirmationMessageConfiguration": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "applicationExperienceDomain": "dev.healtheintent.com",
        "createdAt": "2020-01-20T05:40:02.000Z",
        "updatedAt": "2020-01-20T05:40:02.000Z",
        "renewConfirmationMessage": {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
          "localeTexts": [
            {
              "locale": "en-US",
              "text": "Sample success message."
            }
          ]
        }
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/medications/configurations?offset=0&limit=20"
}

GET /medications/configurations

Retrieves a list of all the configurations for medications that are paginated with the specified parameters. You can also filter the list by domain.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
Accept-Language	header	string	false	en-US	The locale of the configuration.	-
applicationExperienceDomain	query	string	true	N/A	Filters by the domain to which the tenant ID belongs.	-
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	A collection of medications configurations.	MedAllConfigurations
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

COVID Center Site Configuration

The COVID Center Site configurations allows tenants to configure the COVID Center features and the policy text for the COVID Center.

Updates a COVID Center site 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/patient-portal-application/v1/covid-center/site-configs/{siteConfigId}', headers: headers, body: {"domain":"portaleng.patientportal.us-1.staginghealtheintent.com","active":true,"immunizations":true,"discreteResults":true,"referenceRange":true,"documents":true,"vaccineVerification":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/covid-center/site-configs/{siteConfigId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"portaleng.patientportal.us-1.staginghealtheintent.com","active":true,"immunizations":true,"discreteResults":true,"referenceRange":true,"documents":true,"vaccineVerification":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

PUT /covid-center/site-configs/{siteConfigId}

Updates a COVID Center site configuration

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
siteConfigId	path	integer(int32)	true	N/A	No description	-
body	body	putCovidCenterSiteConfigs	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

Retrieves a single feature configuration for COVID Center


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/patient-portal-application/v1/covid-center/site-configs/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/covid-center/site-configs/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "domain": "portaleng.patientportal.us-1.staginghealtheintent.com",
  "active": true,
  "immunizations": true,
  "discreteResults": true,
  "referenceRange": true,
  "documents": true,
  "vaccineVerification": true,
  "notifications": true,
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

GET /covid-center/site-configs/{siteConfigId}

Retrieves a single feature configuration for COVID Center

Parameters

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

Response Statuses

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

Creates a feature configuraton for COVID Center




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/patient-portal-application/v1/covid-center/site-configs', headers: headers, body: {"domain":"portaleng.patientportal.us-1.staginghealtheintent.com","active":true,"immunizations":true,"discreteResults":true,"referenceRange":true,"documents":true,"vaccineVerification":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/covid-center/site-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"portaleng.patientportal.us-1.staginghealtheintent.com","active":true,"immunizations":true,"discreteResults":true,"referenceRange":true,"documents":true,"vaccineVerification":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "domain": "portaleng.patientportal.us-1.staginghealtheintent.com",
  "active": true,
  "immunizations": true,
  "discreteResults": true,
  "referenceRange": true,
  "documents": true,
  "vaccineVerification": true,
  "notifications": true,
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ]
}

POST /covid-center/site-configs

Creates a feature configuraton for COVID Center

Parameters

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

Response Statuses

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

Retrieves a list of feature configurations for COVID Center


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/patient-portal-application/v1/covid-center/site-configs', headers: headers)

print JSON.pretty_generate(result)


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

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "domain": "portaleng.patientportal.us-1.staginghealtheintent.com",
      "active": true,
      "immunizations": true,
      "discreteResults": true,
      "referenceRange": true,
      "documents": true,
      "vaccineVerification": true,
      "notifications": true,
      "policyTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/covid-center/site-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/covid-center/site-configs?offset=0&limit=20"
}

GET /covid-center/site-configs

Retrieves a list of feature configurations for COVID Center

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	The domain for the COVID Center site configuration	-
active	query	boolean	false	N/A	The COVID Center site feature configuration is active or not	-
immunizations	query	boolean	false	N/A	The immunizations in COVID Center site configuration is active or not	-
discreteResults	query	boolean	false	N/A	The discrete results in COVID Center site configuration is active or not	-
referenceRange	query	boolean	false	N/A	The reference range in COVID Center site configuration is active or not	-
documents	query	boolean	false	N/A	The documents in COVID Center site configuration is active or not	-
vaccineVerification	query	boolean	false	N/A	The vaccine verification in COVID Center site configuration is active or not	-
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	OK	SiteConfigs
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Procedures Configuration

Procedures configurations allow you to retrieve, create, update, and delete the configurations for procedures associated with the specified application experience domain.

Update a Procedures 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/patient-portal-application/v1/procedures-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers, body: {"dataSource":"MILLENNIUM","adolescentDataEnabled":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/procedures-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"dataSource":"MILLENNIUM","adolescentDataEnabled":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

PUT /procedures-configurations/{proceduresConfigurationId}

Updates a configuration for procedures.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
proceduresConfigurationId	path	string	true	N/A	The unique ID of the procedures configuration associated with the Health Data Intelligence tenant.	-
body	body	putProceduresConfigurations	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

Delete a Procedures Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/procedures-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/procedures-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /procedures-configurations/{proceduresConfigurationId}

Deletes a specific configuration for procedures.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
proceduresConfigurationId	path	string	true	N/A	The unique ID of the procedures configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Procedures 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/patient-portal-application/v1/procedures-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/procedures-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "testapp.com",
  "dataSource": "MILLENNIUM",
  "adolescentDataEnabled": "true",
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /procedures-configurations/{proceduresConfigurationId}

Retrieves a single configuration for procedures for the HealtheLife Procedures application.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
proceduresConfigurationId	path	string	true	N/A	The unique ID of the procedures configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a List of Procedures Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/procedures-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/procedures-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "testapp.com",
      "dataSource": "MILLENNIUM",
      "adolescentDataEnabled": "true",
      "policyTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ],
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/procedures-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/procedures-configurations?offset=0&limit=20"
}

GET /procedures-configurations

Retrieves a list of configurations for procedures.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the ID of the tenant’s environment.	-
Accept-Language	header	string	false	N/A	The locale of the policy text.	-
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	OK	ProceduresConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Procedures 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/patient-portal-application/v1/procedures-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","dataSource":"MILLENNIUM","adolescentDataEnabled":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/procedures-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","dataSource":"MILLENNIUM","adolescentDataEnabled":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "testapp.com",
  "dataSource": "MILLENNIUM",
  "adolescentDataEnabled": "true",
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /procedures-configurations

Creates a new configuration for procedures.

Parameters

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

Response Statuses

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

Summaries Configuration

Health Summaries configurations allow tenants to configure the following items:

Policy Text: Allow tenants to add the policies, disclaimers and important information in specific locale about the Health Summaries page displayed to the consumer. This allows users to create only one policy text for a locale and these locales are the language codes, example en-US.
startDate: The date when the data for the Health Summaries is available. Data before the configured date is not be available for the end user.
Adolescent Data Enabled:: Adolescent data flag configurations can be enabled or disabled to provide adolescent screening for the specified Health Summaries.
reportTemplateId: The template ID for the CCD report.

Update a Summaries 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/patient-portal-application/v1/summaries-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","adolescentDataEnabled":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}],"reportTemplateId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","startDate":"2020-01-20","enableSeamlessSync":true,"numberOfRetries":4,"allowSyncAfter":9}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/summaries-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","adolescentDataEnabled":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}],"reportTemplateId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","startDate":"2020-01-20","enableSeamlessSync":true,"numberOfRetries":4,"allowSyncAfter":9}

PUT /summaries-configurations/{summariesConfigurationId}

Updates a configuration for summaries.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
summariesConfigurationId	path	string	true	N/A	The unique ID of the summaries configuration associated with the Health Data Intelligence tenant.	-
body	body	putSummariesConfigurations	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

Delete a Summaries Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/summaries-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/summaries-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /summaries-configurations/{summariesConfigurationId}

Deletes a specific configuration for summaries.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
summariesConfigurationId	path	string	true	N/A	The unique ID of the summaries configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a Summaries 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/patient-portal-application/v1/summaries-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/summaries-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "testapp.com",
  "adolescentDataEnabled": true,
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "reportTemplateId": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "startDate": "2020-01-20",
  "enableSeamlessSync": true,
  "numberOfRetries": 4,
  "allowSyncAfter": 8,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /summaries-configurations/{summariesConfigurationId}

Retrieves a single summaries configuration for the HealtheLife summaries application.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
summariesConfigurationId	path	string	true	N/A	The unique ID of the summaries configuration associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve a List of Summaries Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/summaries-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/summaries-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "applicationExperienceDomain": "testapp.com",
      "adolescentDataEnabled": true,
      "policyTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ],
      "reportTemplateId": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "startDate": "2020-01-20",
      "enableSeamlessSync": true,
      "numberOfRetries": 4,
      "allowSyncAfter": 8,
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/summaries-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/summaries-configurations?offset=0&limit=20"
}

GET /summaries-configurations

Retrieves a list of summaries configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the ID of the tenant’s environment.	-
Accept-Language	header	string	false	N/A	The locale of the policy text.	-
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	OK	SummariesConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Summaries 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/patient-portal-application/v1/summaries-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","adolescentDataEnabled":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}],"reportTemplateId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","startDate":"2020-01-20","enableSeamlessSync":true,"numberOfRetries":4,"allowSyncAfter":9}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/summaries-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","adolescentDataEnabled":true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}],"reportTemplateId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","startDate":"2020-01-20","enableSeamlessSync":true,"numberOfRetries":4,"allowSyncAfter":9}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "applicationExperienceDomain": "testapp.com",
  "adolescentDataEnabled": true,
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "reportTemplateId": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "startDate": "2020-01-20",
  "enableSeamlessSync": true,
  "numberOfRetries": 4,
  "allowSyncAfter": 8,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /summaries-configurations

Creates a new configuration for the summaries application.

Parameters

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

Response Statuses

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

Results Configuration

Results configurations allow you to retrieve, create, update, and delete the configurations associated with the specified application experience domain.

Update a 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/patient-portal-application/v1/results-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","educationContentUrl":"https://resultsconfig.learnmore.com","knowledgeBase":{"id":"2bab765b-cbeb-40ef-b557-540ab3841cdf","facilityCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","primaryCriteriaCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","localeCodes":[{"locale":"en-US","code":"151"}]},"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}],"dataSource":"MILLENNIUM","isResultsEnabled":"false","results":{"adolescentDataEnabled":true,"normalcyValuesEnabled":true,"labDelayHours":2},"vitals":{"adolescentDataEnabled":true,"normalcyValuesEnabled":true}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/results-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","educationContentUrl":"https://resultsconfig.learnmore.com","knowledgeBase":{"id":"2bab765b-cbeb-40ef-b557-540ab3841cdf","facilityCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","primaryCriteriaCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","localeCodes":[{"locale":"en-US","code":"151"}]},"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}],"dataSource":"MILLENNIUM","isResultsEnabled":"false","results":{"adolescentDataEnabled":true,"normalcyValuesEnabled":true,"labDelayHours":2},"vitals":{"adolescentDataEnabled":true,"normalcyValuesEnabled":true}}

PUT /results-configurations/{configurationId}

Updates a configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
configurationId	path	string	true	N/A	The unique ID of the configuration associated with the Health Data Intelligence tenant and domain.	-
body	body	putResultsConfigurations	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

Delete a Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/results-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/results-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /results-configurations/{configurationId}

Deletes a configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
configurationId	path	string	true	N/A	The unique ID of the configuration associated with the Health Data Intelligence tenant and domain.	-

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 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/patient-portal-application/v1/results-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/results-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "educationContentUrl": "https://resultsconfig.learnmore.com",
  "dataSource": "MILLENNIUM",
  "isResultsEnabled": "false",
  "results": {
    "adolescentDataEnabled": true,
    "normalcyValuesEnabled": true,
    "labDelayHours": 2
  },
  "vitals": {
    "adolescentDataEnabled": true,
    "normalcyValuesEnabled": true
  },
  "knowledgeBase": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeCodes": [
      {
        "locale": "en-US",
        "code": "151"
      }
    ]
  },
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /results-configurations/{configurationId}

Retrieves a single configuration for the HealtheLife Results application.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
configurationId	path	string	true	N/A	The unique ID of the configuration associated with the Health Data Intelligence tenant and domain.	-

Response Statuses

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

Retrieve a List of Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/results-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/results-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "dev.healtheintent.com",
      "educationContentUrl": "https://resultsconfig.learnmore.com",
      "dataSource": "MILLENNIUM",
      "isResultsEnabled": "false",
      "results": {
        "adolescentDataEnabled": true,
        "normalcyValuesEnabled": true,
        "labDelayHours": 2
      },
      "vitals": {
        "adolescentDataEnabled": true,
        "normalcyValuesEnabled": true
      },
      "knowledgeBase": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeCodes": [
          {
            "locale": "en-US",
            "code": "151"
          }
        ]
      },
      "policyTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ],
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/results-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/results-configurations?offset=0&limit=20"
}

GET /results-configurations

Retrieves a list of configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	Filters by the ID of the tenant’s environment.	-
Accept-Language	header	string	false	N/A	The locale of the policy text.	-
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	OK	ResultsConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a 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/patient-portal-application/v1/results-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","educationContentUrl":"https://resultsconfig.learnmore.com","dataSource":"MILLENNIUM","isResultsEnabled":"false","knowledgeBase":{"facilityCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","primaryCriteriaCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","localeCodes":[{"locale":"en-US","code":"151"}]},"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}],"results":{"adolescentDataEnabled":true,"normalcyValuesEnabled":true,"labDelayHours":2},"vitals":{"adolescentDataEnabled":true,"normalcyValuesEnabled":true}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/results-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","educationContentUrl":"https://resultsconfig.learnmore.com","dataSource":"MILLENNIUM","isResultsEnabled":"false","knowledgeBase":{"facilityCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","primaryCriteriaCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","localeCodes":[{"locale":"en-US","code":"151"}]},"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}],"results":{"adolescentDataEnabled":true,"normalcyValuesEnabled":true,"labDelayHours":2},"vitals":{"adolescentDataEnabled":true,"normalcyValuesEnabled":true}}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.com",
  "educationContentUrl": "https://resultsconfig.learnmore.com",
  "dataSource": "MILLENNIUM",
  "isResultsEnabled": "false",
  "results": {
    "adolescentDataEnabled": true,
    "normalcyValuesEnabled": true,
    "labDelayHours": 2
  },
  "vitals": {
    "adolescentDataEnabled": true,
    "normalcyValuesEnabled": true
  },
  "knowledgeBase": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeCodes": [
      {
        "locale": "en-US",
        "code": "151"
      }
    ]
  },
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /results-configurations

Creates a new configuration.

Parameters

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

Response Statuses

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

Health Summaries Request

Health Summaries Request allows tenants to request the syncing of data and generate the CCD document for the user based on the selected date range and concepts.

Delete a Summaries Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-summaries/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-summaries/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /patient-summaries/{patientSummaryId}

Deletes a specific configuration for summaries.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientSummaryId	path	string	true	N/A	The unique ID of the health summaries request associated with	-

Response Statuses

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

Retrieve a Summaries 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/patient-portal-application/v1/patient-summaries/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-summaries/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "requesterId": "773933",
  "applicationExperienceDomain": "testapp.com",
  "startDate": "2020-01-20",
  "endDate": "2020-01-20",
  "status": "COMPLETE",
  "email": "testpatient@cerner.com",
  "concepts": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cd",
      "name": "IMMUNIZATIONS"
    }
  ],
  "ccdDocuments": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cd",
      "name": "mickey_baker_2020_2021",
      "contentType": "XML",
      "summaryType": "RAW"
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /patient-summaries/{patientSummaryId}

Retrieves a single summaries configuration for the HealtheLife summaries application.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientSummaryId	path	string	true	N/A	The unique ID of the health summaries request associated with	-

Response Statuses

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

Retrieve a List of Summaries Requests


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/patient-portal-application/v1/patient-summaries',
  query: {
  'applicationExperienceDomain' => 'string',
'patientId' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-summaries?applicationExperienceDomain=type,string&patientId=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
      "requesterId": "773933",
      "applicationExperienceDomain": "testapp.com",
      "startDate": "2020-01-20",
      "endDate": "2020-01-20",
      "status": "COMPLETE",
      "email": "testpatient@cerner.com",
      "concepts": [
        {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cd",
          "name": "IMMUNIZATIONS"
        }
      ],
      "ccdDocuments": [
        {
          "id": "2bab765b-cbeb-40ef-b557-540ab3841cd",
          "name": "mickey_baker_2020_2021",
          "contentType": "XML",
          "summaryType": "RAW"
        }
      ],
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-summaries?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-summaries?offset=0&limit=20"
}

GET /patient-summaries

Retrieves a list of summaries Requests.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	true	N/A	Filters by the ID of the tenant’s environment.	-
patientId	query	string	true	N/A	The unique millennium identifier for a patient.	-
startDate	query	string	false	N/A	The date from which the data for the ccd should be available. Data before the configured date will not be available for the end user.	-
endDate	query	string	false	N/A	The date upto which the ccd should be available.	-
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	OK	SummariesRequests
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Summaries Request




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-summaries', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","patientId":"12312-23423sd-34sdfds3-sfsdfsd2","requesterId":"773933","startDate":"2020-01-20","endDate":"2020-01-20","email":"testpatient@cerner.com","concepts":["IMMUNIZATIONS","CONDITIONS"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-summaries \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","patientId":"12312-23423sd-34sdfds3-sfsdfsd2","requesterId":"773933","startDate":"2020-01-20","endDate":"2020-01-20","email":"testpatient@cerner.com","concepts":["IMMUNIZATIONS","CONDITIONS"]}

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
  "requesterId": "773933",
  "applicationExperienceDomain": "testapp.com",
  "startDate": "2020-01-20",
  "endDate": "2020-01-20",
  "status": "COMPLETE",
  "email": "testpatient@cerner.com",
  "concepts": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cd",
      "name": "IMMUNIZATIONS"
    }
  ],
  "ccdDocuments": [
    {
      "id": "2bab765b-cbeb-40ef-b557-540ab3841cd",
      "name": "mickey_baker_2020_2021",
      "contentType": "XML",
      "summaryType": "RAW"
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /patient-summaries

Creates a new Request for the summaries application.

Parameters

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

Response Statuses

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

Retrieves a ccd document by ccdDocumentId.


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/patient-portal-application/v1/patient-summaries/{patientSummaryId}/ccdDocuments/{ccdDocumentId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/patient-summaries/{patientSummaryId}/ccdDocuments/{ccdDocumentId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2bab765b-cbeb-40ef-b557-540ab3841cd",
  "name": "mickey_baker_2020_2021",
  "contentType": "XML",
  "summaryType": "RAW",
  "data": "string",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /patient-summaries/{patientSummaryId}/ccdDocuments/{ccdDocumentId}

Retrieves a ccd document by the specified ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
patientSummaryId	path	string	true	N/A	The unique ID of the health summaries request associated with	-
ccdDocumentId	path	string	true	N/A	The unique identifier of the ccd Document	-

Response Statuses

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

Imaging Configurations

The Imaging configurations allow tenants to configure policy text, viewable image types, and delay hours of the organization. Policy text is a disclaimer or important information for the consumer that is prominently displayed on the Imaging page. Viewable image types indicate the types of images the user can view, and delay hours is the number of hours after the image is available that the file can be viewed.

Create an Imaging 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/patient-portal-application/v1/imaging-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","delayHours":48,"featureEnabled": true,"adolescentDataEnabled": true,"imagingEnabled": true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","delayHours":48,"adolescentDataEnabled": true,"imagingEnabled": true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.net",
  "delayHours": 36,
  "featureEnabled": true,
  "adolescentDataEnabled": true,
  "imagingEnabled": true,
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /imaging-configurations

Creates a new configuration for imaging.

Parameters

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

Response Statuses

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

Retrieve a List of Imaging Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "dev.healtheintent.net",
      "delayHours": 36,
      "featureEnabled": true,
      "adolescentDataEnabled": true,
      "imagingEnabled": true,
      "policyTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ],
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-configurations?offset=0&limit=20"
}

GET /imaging-configurations

Retrieves a list of configurations for imaging.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	The ID of the environment associated with the tenant.	-
Accept-Language	header	string	false	N/A	The locale of the policy text.	-
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	A collection of Imaging Configurations.	ImagingConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete an Imaging Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-configurations/{imagingConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-configurations/{imagingConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /imaging-configurations/{imagingConfigurationId}

Deletes a configuration for imaging.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
imagingConfigurationId	path	string	true	N/A	The unique ID of the imaging configurations associated with the Health Data Intelligence tenant.	-

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 an Imaging 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/patient-portal-application/v1/imaging-configurations/{imagingConfigurationId}', headers: headers, body: {"delayHours":48,"featureEnabled": true,,"adolescentDataEnabled": true,"imagingEnabled": true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-configurations/{imagingConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"delayHours":48,"adolescentDataEnabled": true,"imagingEnabled": true,"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

PUT /imaging-configurations/{imagingConfigurationId}

Updates a configuration for imaging.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
imagingConfigurationId	path	string	true	N/A	The unique ID of the imaging configurations associated with the Health Data Intelligence tenant.	-
body	body	putImagingConfigurations	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 an Imaging 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/patient-portal-application/v1/imaging-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.net",
  "delayHours": 36,
  "featureEnabled": true,
  "adolescentDataEnabled": true,
  "imagingEnabled": true,
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /imaging-configurations/{imagingConfigurationId}

Retrieves a single configuration for imaging for the Imaging application.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
imagingConfigurationId	path	string	true	N/A	The unique ID of the imaging configurations associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Imaging Requests

Imaging Requests allow tenants to provide users with the ability to request the download of a diagnostic study and the ability to generate a .ZIP file consisting of diagnostic study images.

Create an Imaging Request




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

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

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-requests', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","patientId":"12560038","requesterId":"773933","studyId":"urn:vastudy:200CRNR-CM_2_GiqEChE5cKWhWkoZBnZqICEFJqEJRhk~-1013183790V487965","studyDate":"2021-05-26T11:10:29.643-05:00","email":"testpatient@cerner.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-requests \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","patientId":"12560038","requesterId":"773933","studyId":"urn:vastudy:200CRNR-CM_2_GiqEChE5cKWhWkoZBnZqICEFJqEJRhk~-1013183790V487965","studyDate":"2021-05-26T11:10:29.643-05:00","email":"testpatient@cerner.com"}

{
  "id": "1",
  "applicationExperienceDomain": "dev.healtheintent.net",
  "patientId": "12312-23423sd-34sdfds3-sfsdfsd2",
  "requesterId": "773933",
  "studyId": "urn:vastudy:200CRNR-CM_2_GiqEChE5cKWhWkoZBnZqICEFJqEJRhk~-1013183790V487965",
  "studyDate": "2021-05-26T11:10:29.643-05:00",
  "s3Key": "testkey",
  "status": "COMPLETE",
  "email": "testpatient@cerner.com",
  "patientName": "Test Patient",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /imaging-requests

Creates a new request for the Imaging application study download.

Parameters

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

Response Statuses

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

Retrieve a List of Imaging Requests


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/patient-portal-application/v1/imaging-requests',
  query: {
  'applicationExperienceDomain' => 'string',
'patientId' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-requests?applicationExperienceDomain=type,string&patientId=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "1",
      "applicationExperienceDomain": "dev.healtheintent.net",
      "patientId": "12312-23423sd-34sdfds3-sfsdfsd2",
      "requesterId": "773933",
      "studyId": "urn:vastudy:200CRNR-CM_2_GiqEChE5cKWhWkoZBnZqICEFJqEJRhk~-1013183790V487965",
      "studyDate": "2021-05-26T11:10:29.643-05:00",
      "s3Key": "testkey",
      "status": "COMPLETE",
      "email": "testpatient@cerner.com",
      "patientName": "Test Patient",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-requests?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-requests?offset=0&limit=20"
}

GET /imaging-requests

Retrieves a list of imaging requests.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	true	N/A	Filters by the ID of the tenant’s environment.	-
patientId	query	string	true	N/A	The unique Cerner Millennium ID for a patient.	-
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	OK	ImagingRequests
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete an Imaging Request


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/patient-portal-application/v1/imaging-requests/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-requests/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /imaging-requests/{imagingRequestId}

Deletes a specific imaging request.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
imagingRequestId	path	string	true	N/A	The unique ID of the HealtheLife imaging request associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Retrieve an Imaging Request


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/patient-portal-application/v1/imaging-requests/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/imaging-requests/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "1",
  "applicationExperienceDomain": "dev.healtheintent.net",
  "patientId": "12312-23423sd-34sdfds3-sfsdfsd2",
  "requesterId": "773933",
  "studyId": "urn:vastudy:200CRNR-CM_2_GiqEChE5cKWhWkoZBnZqICEFJqEJRhk~-1013183790V487965",
  "studyDate": "2021-05-26T11:10:29.643-05:00",
  "s3Key": "testkey",
  "status": "COMPLETE",
  "email": "testpatient@cerner.com",
  "patientName": "Test Patient",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /imaging-requests/{imagingRequestId}

Retrieves a single imaging request for the Healthelife Imaging application.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
imagingRequestId	path	string	true	N/A	The unique ID of the HealtheLife imaging request associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Health Conditions Configuration

Health Conditions Configuration allows tenants to configure policy text, the adolescent data flag, and the education content web address of the organization. Policy text is a disclaimer or important information for the consumer that is prominently displayed on the Conditions page.

Create a Conditions 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/patient-portal-application/v1/conditions-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.net","adolescentDataEnabled":true,"educationContentUrl":"https://medicationsconfig.learnmore.com","dataSource":"MILLENNIUM","knowledgeBase":{"facilityCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","primaryCriteriaCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","localeCodes":[{"locale":"en-US","code":"151"}]},"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/conditions-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.net","adolescentDataEnabled":true,"educationContentUrl":"https://medicationsconfig.learnmore.com","dataSource":"MILLENNIUM","knowledgeBase":{"facilityCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","primaryCriteriaCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","localeCodes":[{"locale":"en-US","code":"151"}]},"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.net",
  "adolescentDataEnabled": true,
  "educationContentUrl": "https://medicationsconfig.learnmore.com",
  "dataSource": "MILLENNIUM",
  "knowledgeBase": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeCodes": [
      {
        "locale": "en-US",
        "code": "151"
      }
    ]
  },
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /conditions-configurations

Creates a new configuration for conditions.

Parameters

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

Response Statuses

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

Retrieve a List of Conditions Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/conditions-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/conditions-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "applicationExperienceDomain": "dev.healtheintent.net",
      "adolescentDataEnabled": true,
      "educationContentUrl": "https://medicationsconfig.learnmore.com",
      "dataSource": "MILLENNIUM",
      "knowledgeBase": {
        "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
        "localeCodes": [
          {
            "locale": "en-US",
            "code": "151"
          }
        ]
      },
      "policyTexts": [
        {
          "locale": "en-US",
          "text": "Sample Policy Text."
        }
      ],
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/conditions-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/conditions-configurations?offset=0&limit=20"
}

GET /conditions-configurations

Retrieves a list of configurations for conditions.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
applicationExperienceDomain	query	string	false	N/A	The ID of the environment associated with the tenant.	-
Accept-Language	header	string	false	N/A	The locale of the policy text.	-
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	A collection of Conditions Configurations.	ConditionsConfigurations
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Delete a Conditions Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/conditions-configurations/{conditionsConfigurationId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/conditions-configurations/{conditionsConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /conditions-configurations/{conditionsConfigurationId}

Deletes a configuration for conditions.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
conditionsConfigurationId	path	string	true	N/A	The unique ID of the conditions configurations associated with the Health Data Intelligence tenant.	-

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 Conditions 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/patient-portal-application/v1/conditions-configurations/{conditionsConfigurationId}', headers: headers, body: {"adolescentDataEnabled":true,"educationContentUrl":"https://medicationsconfig.learnmore.com","dataSource":"MILLENNIUM","knowledgeBase":{"id":"2bab765b-cbeb-40ef-b557-540ab3841cdf","facilityCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","primaryCriteriaCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","localeCodes":[{"locale":"en-US","code":"151"}]},"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/conditions-configurations/{conditionsConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"adolescentDataEnabled":true,"educationContentUrl":"https://medicationsconfig.learnmore.com","dataSource":"MILLENNIUM","knowledgeBase":{"id":"2bab765b-cbeb-40ef-b557-540ab3841cdf","facilityCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","primaryCriteriaCd":"2bab765b-cbeb-40ef-b557-540ab3841cdf","localeCodes":[{"locale":"en-US","code":"151"}]},"policyTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}

PUT /conditions-configurations/{conditionsConfigurationId}

Updates a configuration for conditions.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
conditionsConfigurationId	path	string	true	N/A	The unique ID of the conditions configurations associated with the Health Data Intelligence tenant.	-
body	body	putConditionsConfigurations	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 Conditions 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/patient-portal-application/v1/conditions-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/conditions-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "applicationExperienceDomain": "dev.healtheintent.net",
  "adolescentDataEnabled": true,
  "educationContentUrl": "https://medicationsconfig.learnmore.com",
  "dataSource": "MILLENNIUM",
  "knowledgeBase": {
    "id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "facilityCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "primaryCriteriaCd": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
    "localeCodes": [
      {
        "locale": "en-US",
        "code": "151"
      }
    ]
  },
  "policyTexts": [
    {
      "locale": "en-US",
      "text": "Sample Policy Text."
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /conditions-configurations/{conditionsConfigurationId}

Retrieves a single configuration for conditions for the HealtheLife Conditions application.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
conditionsConfigurationId	path	string	true	N/A	The unique ID of the conditions configurations associated with the Health Data Intelligence tenant.	-

Response Statuses

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

Clipboard Configurations

Clipboard Configurations allow tenants to configure the Clipboard application, including clipboards, sections, forms, and routing rules.

Retrieve a List of Clipboard Application Configurations


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/patient-portal-application/v1/clipboard-configurations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: en-US'

{
  "items": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "domain": "demo.cernerdemo.us.healtheintent.com",
      "locale": "en-US",
      "enabled": true,
      "orgType": "VETAFFAIR",
      "nameSingular": "Clipboard",
      "namePlural": "Clipboards",
      "availableClipboardsTabName": "Available Clipboards",
      "completedClipboardsTabName": "Completed Clipboards",
      "assignedClipboardsName": "Assigned Clipboards",
      "availableClipboardsName": "Optional Clipboards",
      "policyText": "Sample clipboard application policy text",
      "displayClipboardDaysPrior": 7,
      "createdAt": "2020-01-20T05:40:02.000Z",
      "createdById": "23423423",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "updatedById": "23477777",
      "enableSensitiveStandardForms": true
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-configurations?offset=0&limit=20"
}

GET /clipboard-configurations

Retrieves the clipboard application configurations 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 that the clipboard application configuration belongs to.	-
domain	query	string	false	N/A	Filters by the domain that the clipboard application configuration belongs to.	-
orgType	query	string	false	N/A	Filters by the organization type.	-
enabled	query	boolean	false	N/A	Filters by enabled or disabled clipboard configurations	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

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

Create a Clipboard Application 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/patient-portal-application/v1/clipboard-configurations', headers: headers, body: {"enabled":true,"domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","orgType":"VETAFFAIR","nameSingular":"Clipboard","namePlural":"Clipboards","availableClipboardsTabName":"Available Clipboards","completedClipboardsTabName":"Completed Clipboards","assignedClipboardsName":"Assigned Clipboards","availableClipboardsName":"Optional Clipboards","policyText":"Sample clipboard application policy text","displayClipboardDaysPrior":7,"enableSensitiveStandardForms":true,"createdById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"enabled":true,"domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","orgType":"VETAFFAIR","nameSingular":"Clipboard","namePlural":"Clipboards","availableClipboardsTabName":"Available Clipboards","completedClipboardsTabName":"Completed Clipboards","assignedClipboardsName":"Assigned Clipboards","availableClipboardsName":"Optional Clipboards","policyText":"Sample clipboard application policy text","displayClipboardDaysPrior":7,"enableSensitiveStandardForms":true,"createdById":"23423423"}

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "domain": "demo.cernerdemo.us.healtheintent.com",
  "locale": "en-US",
  "enabled": true,
  "orgType": "VETAFFAIR",
  "nameSingular": "Clipboard",
  "namePlural": "Clipboards",
  "availableClipboardsTabName": "Available Clipboards",
  "completedClipboardsTabName": "Completed Clipboards",
  "assignedClipboardsName": "Assigned Clipboards",
  "availableClipboardsName": "Optional Clipboards",
  "policyText": "Sample clipboard application policy text",
  "displayClipboardDaysPrior": 7,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "23477777",
  "enableSensitiveStandardForms": true
}

POST /clipboard-configurations

Creates a clipboard application configuration.

Parameters

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

Response Statuses

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

Update a Clipboard Application 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/patient-portal-application/v1/clipboard-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"enabled":true,"domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","orgType":"VETAFFAIR","nameSingular":"Clipboard","namePlural":"Clipboards","availableClipboardsTabName":"Available Clipboards","completedClipboardsTabName":"Completed Clipboards","assignedClipboardsName":"Assigned Clipboards","availableClipboardsName":"Optional Clipboards","policyText":"Sample clipboard application policy text","displayClipboardDaysPrior":7,"enableSensitiveStandardForms":true,"updatedById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"enabled":true,"domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","orgType":"VETAFFAIR","nameSingular":"Clipboard","namePlural":"Clipboards","availableClipboardsTabName":"Available Clipboards","completedClipboardsTabName":"Completed Clipboards","assignedClipboardsName":"Assigned Clipboards","availableClipboardsName":"Optional Clipboards","policyText":"Sample clipboard application policy text","displayClipboardDaysPrior":7,"enableSensitiveStandardForms":true,"updatedById":"23423423"}

PUT /clipboard-configurations/{clipboardConfigurationId}

Updates a clipboard application configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardConfigurationId	path	string	true	N/A	The unique ID of the clipboard application configuration.	-
body	body	putClipboardConfigurations	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Clipboard Application 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/patient-portal-application/v1/clipboard-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "domain": "demo.cernerdemo.us.healtheintent.com",
  "locale": "en-US",
  "enabled": true,
  "orgType": "VETAFFAIR",
  "nameSingular": "Clipboard",
  "namePlural": "Clipboards",
  "availableClipboardsTabName": "Available Clipboards",
  "completedClipboardsTabName": "Completed Clipboards",
  "assignedClipboardsName": "Assigned Clipboards",
  "availableClipboardsName": "Optional Clipboards",
  "policyText": "Sample clipboard application policy text",
  "displayClipboardDaysPrior": 7,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "23477777",
  "enableSensitiveStandardForms": true
}

GET /clipboard-configurations/{clipboardConfigurationId}

Retrieves a single clipboard application configuration for clipboards.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardConfigurationId	path	string	true	N/A	The unique ID of the clipboard application configuration.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single clipboard application configuration.	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ClipboardConfig
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Clipboard Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "domain": "demo.cernerdemo.us.healtheintent.com",
      "locale": "en-US",
      "version": 1,
      "active": true,
      "orgType": "VETAFFAIR",
      "name": "Clipboard Name",
      "nameFriendly": "Member-Facing Clipboard Name",
      "clipboardRetired": true,
      "createdAt": "2020-01-20T05:40:02.000Z",
      "createdById": "23423423",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "updatedById": "23477777"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards?offset=0&limit=20"
}

GET /clipboards

Retrieves the clipboard configurations that meet the specified parameters.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	Filters by the domain that the clipboard configuration belongs to.	-
active	query	boolean	false	N/A	Filters by active or inactive clipboards.	-
orgType	query	string	false	N/A	Filters by the organization type.	-
ids	query	string	false	N/A	Filters by the clipboard ID or IDs passed in.	-
name	query	string	false	N/A	Filters by the clipboard name.	-
version	query	integer(int32)	false	N/A	Filters by the clipboard version.	-
Accept-Language	header	string	false	en-US	Filters by the locale that the clipboard configuration belongs to.	-
orderBy	query	string	false	createdAt	Sorts the clipboard by the given value.	-
appointmentTypeCode	query	string	false	N/A	Returns all active clipboards with either a routing rule that matches this value and the locationCode query parameter, or a routing rule that matches this value and has a blank location code.	-
locationCode	query	string	false	N/A	Returns all active clipboards with either a routing rule that matches this value and the appointmentTypeCode query parameter, or a routing rule that matches this value and has a blank appointment type code.	-
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.	ClipboardBasics
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Create a Clipboard 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/patient-portal-application/v1/clipboards', headers: headers, body: {"domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","name":"Clipboard Name","nameFriendly":"Member-Facing Clipboard Name","policyText":"Sample clipboard policy text","requestRemovalPolicyText":"Sample clipboard removal policy text","successMessagePolicyText":"Sample clipboard success message policy","createdById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","name":"Clipboard Name","nameFriendly":"Member-Facing Clipboard Name","policyText":"Sample clipboard policy text","requestRemovalPolicyText":"Sample clipboard removal policy text","successMessagePolicyText":"Sample clipboard success message policy","createdById":"23423423"}

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "domain": "demo.cernerdemo.us.healtheintent.com",
  "locale": "en-US",
  "version": 1,
  "active": true,
  "orgType": "VETAFFAIR",
  "name": "Clipboard Name",
  "nameFriendly": "Member-Facing Clipboard Name",
  "clipboardRetired": true,
  "policyText": "Sample clipboard policy text",
  "requestRemovalPolicyText": "Sample clipboard removal policy text",
  "successMessagePolicyText": "Sample clipboard success message policy",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "23477777"
}

POST /clipboards

Creates a clipboard configuration.

Parameters

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

Response Statuses

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

Update a Clipboard 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/patient-portal-application/v1/clipboards/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"active":true,"domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","nameFriendly":"Member-Facing Clipboard Name","policyText":"Sample clipboard policy text","requestRemovalPolicyText":"Sample clipboard removal policy text","successMessagePolicyText":"Sample clipboard success message policy","sections":[{"sectionId":"2367cc4d-0496-4b2f-ad3a-3630dc4fd828","sectionPosition":1}],"updatedById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"active":true,"domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","nameFriendly":"Member-Facing Clipboard Name","policyText":"Sample clipboard policy text","requestRemovalPolicyText":"Sample clipboard removal policy text","successMessagePolicyText":"Sample clipboard success message policy","sections":[{"sectionId":"2367cc4d-0496-4b2f-ad3a-3630dc4fd828","sectionPosition":1}],"updatedById":"23423423"}

PUT /clipboards/{clipboardId}

Updates a clipboard configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
body	body	putClipboards	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Clipboard 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/patient-portal-application/v1/clipboards/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "domain": "demo.cernerdemo.us.healtheintent.com",
  "locale": "en-US",
  "version": 1,
  "active": true,
  "orgType": "VETAFFAIR",
  "name": "Clipboard Name",
  "nameFriendly": "Member-Facing Clipboard Name",
  "clipboardRetired": true,
  "policyText": "Sample clipboard policy text",
  "requestRemovalPolicyText": "Sample clipboard removal policy text",
  "successMessagePolicyText": "Sample clipboard success message policy",
  "sections": [
    {
      "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
      "name": "Section Name",
      "description": "Section description",
      "millenniumDocumentCode": "12312431",
      "position": 1,
      "forms": [
        {
          "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
          "type": "STANDARD",
          "name": "Clipboard Form ABC",
          "nameFriendly": "Member Form ABC",
          "position": 1
        }
      ]
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "23477777"
}

GET /clipboards/{clipboardId}

Retrieves a single clipboard configuration.

Parameters

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

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single clipboard configuration.	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_Clipboard
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Clipboard Section 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/patient-portal-application/v1/clipboards/{clipboardId}/sections', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/sections \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
      "version": 1,
      "name": "Section Name",
      "description": "Section description",
      "millenniumDocumentCode": "12312431",
      "position": 1,
      "createdAt": "2020-01-20T05:40:02.000Z",
      "createdById": "23423423",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "updatedById": "23477777"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/e2b057ac-fd58-4323-88e5-1b193c2fbe27/sections?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/e2b057ac-fd58-4323-88e5-1b193c2fbe27/sections?offset=0&limit=20"
}

GET /clipboards/{clipboardId}/sections

Retrieves the clipboard section configurations that meet the specified parameters.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-

Response Statuses

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

Create a Clipboard Section 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/patient-portal-application/v1/clipboards/{clipboardId}/sections', headers: headers, body: {"name":"Section Name","description":"Section description","millenniumDocumentCode":"12312431","forms":[{"formType":"STANDARD","formId":"2367cc4d-0496-4b2f-ad3a-3630dc4fd828","formPosition":1}],"createdById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/sections \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Section Name","description":"Section description","millenniumDocumentCode":"12312431","forms":[{"formType":"STANDARD","formId":"2367cc4d-0496-4b2f-ad3a-3630dc4fd828","formPosition":1}],"createdById":"23423423"}

{
  "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
  "clipboardId": "06e0fc5c-d986-4681-a31f-e360cf714b05",
  "version": 1,
  "name": "Section Name",
  "description": "Section description",
  "millenniumDocumentCode": "12312431",
  "position": 1,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "23477777",
  "forms": [
    {
      "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
      "type": "STANDARD",
      "position": 1
    }
  ]
}

POST /clipboards/{clipboardId}/sections

Creates a clipboard section configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
body	body	postClipboardsClipboardidSections	true	N/A	No description	-

Response Statuses

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

Update a Clipboard Section 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/patient-portal-application/v1/clipboards/{clipboardId}/sections/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"description":"Section description","millenniumDocumentCode":"12312431","forms":[{"formType":"STANDARD","formId":"2367cc4d-0496-4b2f-ad3a-3630dc4fd828","formPosition":1}],"updatedById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/sections/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"description":"Section description","millenniumDocumentCode":"12312431","forms":[{"formType":"STANDARD","formId":"2367cc4d-0496-4b2f-ad3a-3630dc4fd828","formPosition":1}],"updatedById":"23423423"}

{
  "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
  "clipboardId": "06e0fc5c-d986-4681-a31f-e360cf714b05",
  "version": 1,
  "name": "Section Name",
  "description": "Section description",
  "millenniumDocumentCode": "12312431",
  "position": 1,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "23477777",
  "forms": [
    {
      "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
      "type": "STANDARD",
      "position": 1
    }
  ]
}

PUT /clipboards/{clipboardId}/sections/{sectionId}

Updates a clipboard section configuration

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
sectionId	path	string	true	N/A	The unique ID of the clipboard section configuration.	-
body	body	putClipboardsClipboardidSections	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Clipboard Section 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/patient-portal-application/v1/clipboards/{clipboardId}/sections/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/sections/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
  "version": 1,
  "name": "Section Name",
  "description": "Section description",
  "millenniumDocumentCode": "12312431",
  "position": 1,
  "forms": [
    {
      "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
      "type": "STANDARD",
      "name": "Clipboard Form ABC",
      "nameFriendly": "Member Form ABC",
      "position": 1
    }
  ],
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "23477777"
}

GET /clipboards/{clipboardId}/sections/{sectionId}

Retrieves a single clipboard section configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
sectionId	path	string	true	N/A	The unique ID of the clipboard section configuration.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single clipboard section configuration.	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_GetSection
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Clipboard Routing Rule 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/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "clipboardId": "e88ac82e-8548-4eb7-b87d-487a988b0afa",
      "appointmentType": {
        "name": "Annual Checkup",
        "code": "CHECKUP"
      },
      "location": {
        "name": "Medical Building",
        "code": "MEDICAL_BLDG_1"
      },
      "routedRecipient": {
        "type": "PERSONNEL",
        "id": "12341234"
      },
      "createdAt": "2020-01-20T05:40:02.000Z",
      "createdById": "23423423",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/e2b057ac-fd58-4323-88e5-1b193c2fbe27/routing-rules?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/e2b057ac-fd58-4323-88e5-1b193c2fbe27/routing-rules?offset=0&limit=20"
}

GET /clipboards/{clipboardId}/routing-rules

Retrieves the clipboard routing rule configurations that meet the specified parameters.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
appointmentTypeCode	query	string	false	N/A	Returns all routing rules for this clipboard that either match this value and the locationCode query parameter, or matches this value and has a blank location code. If no matching rules are found, and a routing rule was defined for this clipboard with a blank appointment type and blank location, then that routing rule is returned.	-
locationCode	query	string	false	N/A	Returns all routing rules for this clipboard that either match this value and the appointmentTypeCode query parameter, or match this value and have a blank appointment type code. If no matching rules are found, and a routing rule was defined for this clipboard with a blank appointment type and blank location, then that routing rule is returned.	-

Response Statuses

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

Create a Clipboard Routing Rule 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/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules', headers: headers, body: {"appointmentType":{"name":"Annual Checkup","code":"CHECKUP"},"location":{"name":"Medical Building","code":"MEDICAL_BLDG_1"},"routedRecipient":{"type":"PERSONNEL","id":"12341234"},"createdById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"appointmentType":{"name":"Annual Checkup","code":"CHECKUP"},"location":{"name":"Medical Building","code":"MEDICAL_BLDG_1"},"routedRecipient":{"type":"PERSONNEL","id":"12341234"},"createdById":"23423423"}

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "clipboardId": "e88ac82e-8548-4eb7-b87d-487a988b0afa",
  "appointmentType": {
    "name": "Annual Checkup",
    "code": "CHECKUP"
  },
  "location": {
    "name": "Medical Building",
    "code": "MEDICAL_BLDG_1"
  },
  "routedRecipient": {
    "type": "PERSONNEL",
    "id": "12341234"
  },
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /clipboards/{clipboardId}/routing-rules

Create a clipboard routing rule configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
body	body	postClipboardsClipboardidRoutingRules	true	N/A	No description	-

Response Statuses

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

Delete a Clipboard Routing Rule Configuration


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

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

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules/75323063-2b6d-4f80-b3ee-ab167d18c8b7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules/75323063-2b6d-4f80-b3ee-ab167d18c8b7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /clipboards/{clipboardId}/routing-rules/{routingRuleId}

Deletes a clipboard routing rule configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
routingRuleId	path	string	true	N/A	The unique ID of the clipboard routing rule configuration.	-

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

Retrieve a Single Clipboard Routing Rule 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/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "clipboardId": "e88ac82e-8548-4eb7-b87d-487a988b0afa",
  "appointmentType": {
    "name": "Annual Checkup",
    "code": "CHECKUP"
  },
  "location": {
    "name": "Medical Building",
    "code": "MEDICAL_BLDG_1"
  },
  "routedRecipient": {
    "type": "PERSONNEL",
    "id": "12341234"
  },
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /clipboards/{clipboardId}/routing-rules/{routingRuleId}

Retrieves a single clipboard routing rule configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
routingRuleId	path	string	true	N/A	The unique ID of the clipboard routing rule configuration.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single clipboard routing rule configuration.	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_RoutingRule
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Create Multiple Clipboard Routing Rule Configurations




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/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules-bulk', headers: headers, body: {"routingRules":[{"clipboardId":"e88ac82e-8548-4eb7-b87d-487a988b0afa","appointmentType":{"name":"Annual Checkup","code":"CHECKUP"},"location":{"name":"Medical Building","code":"MEDICAL_BLDG_1"},"routedRecipient":{"type":"PERSONNEL","id":"12341234"}}],"createdById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboards/{clipboardId}/routing-rules-bulk \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"routingRules":[{"clipboardId":"e88ac82e-8548-4eb7-b87d-487a988b0afa","appointmentType":{"name":"Annual Checkup","code":"CHECKUP"},"location":{"name":"Medical Building","code":"MEDICAL_BLDG_1"},"routedRecipient":{"type":"PERSONNEL","id":"12341234"}}],"createdById":"23423423"}

POST /clipboards/{clipboardId}/routing-rules-bulk

Creates multiple clipboard routing rule configurations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
clipboardId	path	string	true	N/A	The unique ID of the clipboard configuration.	-
body	body	postClipboardsClipboardidRoutingRulesBulk	true	N/A	No description	-

Response Statuses

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

Retrieve a List of Clipboard Standard Form Configurations


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "domain": "demo.cernerdemo.us.healtheintent.com",
      "locale": "en-US",
      "standardFormType": "ALLERGIES",
      "name": "Allergies",
      "nameFriendly": "Allergies",
      "policyText": "Sample form policy text",
      "codifiedLists": [
        {
          "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
          "name": "Allergies",
          "type": "ALLERGIES"
        }
      ],
      "allowFreeText": true,
      "createdAt": "2020-01-20T05:40:02.000Z",
      "createdById": "23423423",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "updatedById": "23477777"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms?offset=0&limit=20"
}

GET /clipboard-standard-forms

Retrieves the clipboard standard form configurations that meet the specified parameters.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
domain	query	string	false	N/A	Filters by the domain that the standard form belongs to.	-
Accept-Language	header	string	false	en-US	Filters by the locale that the standard form belongs to.	-
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.	StandardForms
400	Bad Request	Bad Request	Error
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error

Update a Clipboard Standard Form 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/patient-portal-application/v1/clipboard-standard-forms/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"nameFriendly":"Allergies","policyText":"Sample form policy text","allowFreeText":true,"updatedById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"nameFriendly":"Allergies","policyText":"Sample form policy text","allowFreeText":true,"updatedById":"23423423"}

PUT /clipboard-standard-forms/{standardFormId}

Updates a clipboard standard form configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
standardFormId	path	string	true	N/A	The unique ID of the clipboard standard form configuration.	-
body	body	putClipboardStandardForms	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Clipboard Standard Form 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/patient-portal-application/v1/clipboard-standard-forms/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "domain": "demo.cernerdemo.us.healtheintent.com",
  "locale": "en-US",
  "standardFormType": "ALLERGIES",
  "name": "Allergies",
  "nameFriendly": "Allergies",
  "policyText": "Sample form policy text",
  "codifiedLists": [
    {
      "id": "2367cc4d-0496-4b2f-ad3a-3630dc4fd828",
      "name": "Allergies",
      "type": "ALLERGIES"
    }
  ],
  "allowFreeText": true,
  "createdAt": "2020-01-20T05:40:02.000Z",
  "createdById": "23423423",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "23477777"
}

GET /clipboard-standard-forms/{standardFormId}

Retrieves a single clipboard standard form configuration.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
standardFormId	path	string	true	N/A	The unique ID of the clipboard standard form configuration.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single clipboard standard form configuration.	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_StandardForm
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Retrieve a List of Codified Choices


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/patient-portal-application/v1/clipboard-standard-forms/{standardFormId}/codified-lists/{codifiedListId}/choices', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms/{standardFormId}/codified-lists/{codifiedListId}/choices \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "allergies": [
        {
          "id": "9c6d5532-be0e-4367-ad9d-af02c3e7a30e",
          "nameFriendly": "Bee Stings",
          "allergyName": "Bee Stings",
          "nomenclatureId": "966633"
        }
      ],
      "reactions": [
        {
          "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
          "nameFriendly": "Cough",
          "reactionName": "Cough",
          "nomenclatureId": "7839964"
        }
      ],
      "healthIssues": [
        {
          "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
          "nameFriendly": "Depression",
          "healthIssue": "Depression",
          "nomenclatureId": "8245821"
        }
      ],
      "proceduresAndSurgeries": [
        {
          "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
          "nameFriendly": "Adenoidectomy",
          "procedureName": "Adenoidectomy",
          "nomenclatureId": "8190160"
        }
      ],
      "immunizations": [
        {
          "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
          "nameFriendly": "COVID-19 vaccine",
          "immunizationName": "COVID-19",
          "eventCode": "876234"
        }
      ],
      "familyHistory": [
        {
          "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
          "nameFriendly": "Diabetes",
          "conditionName": "Diabetes mellitus",
          "category": "Common Conditions",
          "nomenclatureId": "7203333"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms/e2b057ac-fd58-4323-88e5-1b193c2fbe27/codified-lists/8ee87e4f-743d-4d9e-aec4-99ceec9e6e94/choices?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms/e2b057ac-fd58-4323-88e5-1b193c2fbe27/codified-lists/8ee87e4f-743d-4d9e-aec4-99ceec9e6e94/choices?offset=0&limit=20"
}

GET /clipboard-standard-forms/{standardFormId}/codified-lists/{codifiedListId}/choices

Retrieves a list of Codified Choices that meet the specified parameters. Response contains 1 property where value is a List of Codified Choices.The following keys are supported:allergies, reactions, healthIssues, proceduresAndSurgeries, immunizations, familyHistory.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
standardFormId	path	string	true	N/A	The unique ID of the clipboard standard form configuration.	-
codifiedListId	path	string	true	N/A	The unique ID of the codified list form configuration.	-
name	query	string	false	N/A	Filters the list of choices by friendly name or name:	-
excludeNomenclatureIds	query	array[string]	false	N/A	Exclude choices with provided nomenclature ids. Works only for choices which have nomenclatureId property.	-
excludeEventCodes	query	array[string]	false	N/A	Exclude choices with provided event codes. Works only for choices which have eventCode property.	-
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.	-allergyName, -healthIssue, -conditionName, -immunizationName, -procedureName, -reactionName, -eventCode, -nomenclatureId, -nameFriendly, -category, -createdAt, allergyName, healthIssue, conditionName, immunizationName, procedureName, reactionName, eventCode, nomenclatureId, nameFriendly, category, createdAt

Response Statuses

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

Delete a Codified Choice


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/patient-portal-application/v1/clipboard-standard-forms/{standardFormId}/codified-lists/{codifiedListId}/choices/75323063-2b6d-4f80-b3ee-ab167d18c8b7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms/{standardFormId}/codified-lists/{codifiedListId}/choices/75323063-2b6d-4f80-b3ee-ab167d18c8b7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /clipboard-standard-forms/{standardFormId}/codified-lists/{codifiedListId}/choices/{codifiedChoiceId}

Deletes a codified choice

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
standardFormId	path	string	true	N/A	The unique ID of the clipboard standard form configuration.	-
codifiedListId	path	string	true	N/A	The unique ID of the codified list form configuration.	-
codifiedChoiceId	path	string	true	N/A	The unique ID of the codified choice form configuration.	-

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

Create Multiple Codified Choices of one type




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/patient-portal-application/v1/clipboard-standard-forms/{standardFormId}/codified-lists/{codifiedListId}/choices-bulk', headers: headers, body: {"allergies":[{"nameFriendly":"Bee Stings","allergyName":"Bee Stings","nomenclatureId":"966633"}],"reactions":[{"nameFriendly":"Cough","reactionName":"Cough","nomenclatureId":"7839964"}],"healthIssues":[{"nameFriendly":"Depression","healthIssue":"Depression","nomenclatureId":"8245821"}],"proceduresAndSurgeries":[{"nameFriendly":"Adenoidectomy","procedureName":"Adenoidectomy","nomenclatureId":"8190160"}],"immunizations":[{"nameFriendly":"COVID-19 vaccine","immunizationName":"COVID-19","eventCode":"876234"}],"familyHistory":[{"nameFriendly":"Diabetes","conditionName":"Diabetes mellitus","category":"Common Conditions","nomenclatureId":"7203333"}],"createdById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-standard-forms/{standardFormId}/codified-lists/{codifiedListId}/choices-bulk \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"allergies":[{"nameFriendly":"Bee Stings","allergyName":"Bee Stings","nomenclatureId":"966633"}],"reactions":[{"nameFriendly":"Cough","reactionName":"Cough","nomenclatureId":"7839964"}],"healthIssues":[{"nameFriendly":"Depression","healthIssue":"Depression","nomenclatureId":"8245821"}],"proceduresAndSurgeries":[{"nameFriendly":"Adenoidectomy","procedureName":"Adenoidectomy","nomenclatureId":"8190160"}],"immunizations":[{"nameFriendly":"COVID-19 vaccine","immunizationName":"COVID-19","eventCode":"876234"}],"familyHistory":[{"nameFriendly":"Diabetes","conditionName":"Diabetes mellitus","category":"Common Conditions","nomenclatureId":"7203333"}],"createdById":"23423423"}

POST /clipboard-standard-forms/{standardFormId}/codified-lists/{codifiedListId}/choices-bulk

Creates multiple codified choices

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
standardFormId	path	string	true	N/A	The unique ID of the clipboard standard form configuration.	-
codifiedListId	path	string	true	N/A	The unique ID of the codified list form configuration.	-
body	body	postClipboardStandardFormsStandardformidCodifiedListsCodifiedlistidChoicesBulk	true	N/A	No description	-

Response Statuses

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

Retrieve a List of Clipboard Custom Forms


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Accept-Language' => {
  "type": "string",
  "default": "en-US"
}
}

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-custom-forms', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-custom-forms \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'

{
  "items": [
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "name": "Custom Form Name",
      "nameFriendly": "A Patient Friendly Name",
      "domain": "demo.cernerdemo.us.healtheintent.com",
      "locale": "en-US",
      "policyText": "Sample form policy text",
      "isSensitive": true,
      "version": 1,
      "active": true,
      "createdById": "JSMITH",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedById": "JSMITH",
      "updatedAt": "2020-01-20T05:40:02.000Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-custom-forms?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-custom-forms?offset=0&limit=20"
}

GET /clipboard-custom-forms

Retrieves the clipboard custom forms that meet the specified parameters.

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.	-
domain	query	string	false	N/A	Filters by the domain that the custom forms belongs to.	-
active	query	boolean	false	N/A	Filters by the active or inactive custom forms.	-
name	query	string	false	N/A	Filters by the name of the custom forms.	-
version	query	integer(int32)	false	N/A	Filters by the version of the custom forms.	-
orderBy	query	string	false	createdAt	Sorts the custom forms by the given value.	-
Accept-Language	header	string	false	en-US	Filters by the locale that the custom forms belongs to.	-

Response Statuses

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

Create a Clipboard 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/patient-portal-application/v1/clipboard-custom-forms', headers: headers, body: {"createdById":"23423423","name":"Custom Form Name","nameFriendly":"A Patient Friendly Name","domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","policyText":"Sample form policy text","isSensitive":true,"contents":[{"type":"TEXTBOX","fields":{"text":"Please answer the following questions about your visit."},"position":1},{"type":"QUESTION","fields":{"label":"When was your last visit?","isRequired":false,"isPatientViewableScore":false,"dtaId":"18751318"},"position":2}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-custom-forms \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"createdById":"23423423","name":"Custom Form Name","nameFriendly":"A Patient Friendly Name","domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","policyText":"Sample form policy text","isSensitive":true,"contents":[{"type":"TEXTBOX","fields":{"text":"Please answer the following questions about your visit."},"position":1},{"type":"QUESTION","fields":{"label":"When was your last visit?","isRequired":false,"isPatientViewableScore":false,"dtaId":"18751318"},"position":2}]}

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "name": "Custom Form Name",
  "nameFriendly": "A Patient Friendly Name",
  "domain": "demo.cernerdemo.us.healtheintent.com",
  "locale": "en-US",
  "policyText": "Sample form policy text",
  "isSensitive": true,
  "version": 1,
  "active": true,
  "contents": [
    {
      "id": "3c3fc28d-d8ec-4396-8478-efed86cface9",
      "type": "TEXTBOX",
      "fields": {
        "text": "Please answer the following questions about your visit."
      },
      "position": 1
    },
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "type": "QUESTION",
      "fields": {
        "label": "When was your last visit?",
        "isRequired": false,
        "isPatientViewableScore": false,
        "dta": {
          "id": "991238273",
          "type": "ALPHA",
          "eventCode": "1823785"
        }
      },
      "position": 2
    }
  ],
  "createdById": "JSMITH",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "JSMITH",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

POST /clipboard-custom-forms

Creates a clipboard custom form.

Parameters

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

Response Statuses

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

Update a Clipboard Custom 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/patient-portal-application/v1/clipboard-custom-forms/87344a96-1612-4fe6-bbe5-189f29b12efd', headers: headers, body: {"nameFriendly":"A Patient Friendly Name","domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","policyText":"Sample form policy text","isSensitive":true,"active":true,"contents":[{"type":"QUESTION","position":1,"fields":{"label":"When was your last visit?","isRequired":false,"isPatientViewableScore":false,"dtaId":"991238273"}}],"updatedById":"23423423"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-custom-forms/87344a96-1612-4fe6-bbe5-189f29b12efd \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"nameFriendly":"A Patient Friendly Name","domain":"demo.cernerdemo.us.healtheintent.com","locale":"en-US","policyText":"Sample form policy text","isSensitive":true,"active":true,"contents":[{"type":"QUESTION","position":1,"fields":{"label":"When was your last visit?","isRequired":false,"isPatientViewableScore":false,"dtaId":"991238273"}}],"updatedById":"23423423"}

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "name": "Custom Form Name",
  "nameFriendly": "A Patient Friendly Name",
  "domain": "demo.cernerdemo.us.healtheintent.com",
  "locale": "en-US",
  "policyText": "Sample form policy text",
  "isSensitive": true,
  "version": 1,
  "active": true,
  "contents": [
    {
      "id": "3c3fc28d-d8ec-4396-8478-efed86cface9",
      "type": "TEXTBOX",
      "fields": {
        "text": "Please answer the following questions about your visit."
      },
      "position": 1
    },
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "type": "QUESTION",
      "fields": {
        "label": "When was your last visit?",
        "isRequired": false,
        "isPatientViewableScore": false,
        "dta": {
          "id": "991238273",
          "type": "ALPHA",
          "eventCode": "1823785"
        }
      },
      "position": 2
    }
  ],
  "createdById": "JSMITH",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "JSMITH",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

PUT /clipboard-custom-forms/{customFormId}

Updates a clipboard custom form.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
customFormId	path	string	true	N/A	The unique ID of the clipboard custom form	-
body	body	putClipboardCustomForms	true	N/A	No description	-

Response Statuses

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

Retrieve a Single Clipboard Custom Form


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

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

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-custom-forms/87344a96-1612-4fe6-bbe5-189f29b12efd', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/clipboard-custom-forms/87344a96-1612-4fe6-bbe5-189f29b12efd \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
  "name": "Custom Form Name",
  "nameFriendly": "A Patient Friendly Name",
  "domain": "demo.cernerdemo.us.healtheintent.com",
  "locale": "en-US",
  "policyText": "Sample form policy text",
  "isSensitive": true,
  "version": 1,
  "active": true,
  "contents": [
    {
      "id": "3c3fc28d-d8ec-4396-8478-efed86cface9",
      "type": "TEXTBOX",
      "fields": {
        "text": "Please answer the following questions about your visit."
      },
      "position": 1
    },
    {
      "id": "8ee87e4f-743d-4d9e-aec4-99ceec9e6e94",
      "type": "QUESTION",
      "fields": {
        "label": "When was your last visit?",
        "isRequired": false,
        "isPatientViewableScore": false,
        "dta": {
          "id": "991238273",
          "type": "ALPHA",
          "eventCode": "1823785"
        }
      },
      "position": 2
    }
  ],
  "createdById": "JSMITH",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedById": "JSMITH",
  "updatedAt": "2020-01-20T05:40:02.000Z"
}

GET /clipboard-custom-forms/{customFormId}

Retrieves a single clipboard custom form.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
customFormId	path	string	true	N/A	The unique ID of the clipboard custom form	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	A single clipboard custom form.	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_CustomForm
401	Unauthorized	Unauthorized	Error
403	Forbidden	Forbidden	Error
404	Not Found	Not Found	Error

Schema Definitions

MillenniumOauthConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_MillenniumOauthConfiguration

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the Cerner Millennium configuration.	-
consumerKey	string	false	The key to access the services associated with the tenant.	-
millenniumTenantId	string	false	The tenant ID for a given Cerner Millennium domain.	-
isMillenniumNonProd	boolean	false	Indicates whether the configuration is for a nonproduction domain.	-

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

postMillenniumOauthConfigurations

Name	Type	Required	Description	Accepted Values
consumerKey	string	true	The key to access the services associated with the tenant.	-
consumerSecret	string	true	The secret to access the services associated with the tenant.	-
millenniumTenantId	string	true	The cloud identity and access management (IAM) tenant ID that is unique to a Cerner Millennium domain.	-
isMillenniumNonProd	boolean	true	Indicates whether the Cerner Millennium domain is a nonproduction domain. For production domains, this value is `false`; for nonproduction domains such as mock, certification, and staging, this value is `true`.	-

putMillenniumOauthConfigurations

Name	Type	Required	Description	Accepted Values
consumerKey	string	false	The key to access the services associated with the tenant.	-
consumerSecret	string	false	The secret to access the services associated with the tenant.	-
millenniumTenantId	string	false	The cloud IAM tenant ID that is unique to a Cerner Millennium domain.	-
isMillenniumNonProd	boolean	false	Indicates whether the Cerner Millennium domain is a nonproduction domain. For production domains, this value is `false`; for nonproduction domains such as mock, certification, and staging, this value is `true`.	-

MillenniumConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_MillenniumConfigurations_MillenniumConfiguration

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of a Cerner Millennium configuration.	-
domainUri	string	false	A unique domain name with which the Cerner Millennium configuration is associated.	-
millenniumConfig	PatientPortalApplicationPublicApi_Entities_V1_MillenniumConfigurations_Configuration	false	The associated Cerner Millennium OAuth configuration.	-

PatientPortalApplicationPublicApi_Entities_V1_MillenniumConfigurations_Configuration

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of a saved Cerner Millennium configuration.	-

postMillenniumConfigurations

Name	Type	Required	Description	Accepted Values
domainUri	string	true	The domain URI.	-
millenniumConfig	object	true	The associated Cerner Millennium OAuth configuration.	-
» id	string	true	The ID of the Cerner Millennium OAuth configuration.	-

putMillenniumConfigurations

Name	Type	Required	Description	Accepted Values
millenniumConfig	object	true	The associated Cerner Millennium OAuth configuration.	-
» id	string	true	The ID of the Cerner Millennium OAuth configuration.	-

AmwellConfigurations

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

VideoVisits_AmwellConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the Amwell configuration.	-
sdk	VideoVisits_Sdk	false	The Amwell SDK configurations required to configure a video visit.	-
enrollment	VideoVisits_Enrollment	false	The Amwell enrollment configurations required to configure a video visit.	-
converge	VideoVisits_Converge	false	The Amwell Converge configurations required to configure a video visit.	-

VideoVisits_Sdk

Name	Type	Required	Description	Accepted Values
key	string	true	The key used by the application to interact with the Amwell API.	-
mobileKey	string	true	The mobile key used by the application to interact with the Amwell API.	-
apiUrl	string	true	The Amwell API endpoint.	-

VideoVisits_Enrollment

Name	Type	Required	Description	Accepted Values
user	string	true	The username used by the application to interact with the Amwell enrollment service.	-
password	string	true	The password used by the application to interact with the Amwell enrollment service.	-
url	string	true	The Amwell enrollment service endpoint.	-

VideoVisits_Converge

Name	Type	Required	Description	Accepted Values
appId	string	true	Identifies which instance of the Amwell Converge smart app to be used.	-

postAmwellConfigurations

Name	Type	Required	Description	Accepted Values
sdk	object	false	The Amwell SDK configurations required to configure a video visit.	-
» key	string	true	The key used by the application to interact with the Amwell API.	-
» mobileKey	string	true	The mobile key used by the application to interact with the Amwell API.	-
» apiUrl	string	true	The Amwell API endpoint.	-
enrollment	object	false	The Amwell enrollment configurations required to configure a video visit.	-
» user	string	true	The username used by the application to interact with the Amwell enrollment service.	-
» password	string	true	The password used by the application to interact with the Amwell enrollment service.	-
» url	string	true	The Amwell enrollment service endpoint.	-
converge	object	false	The Amwell Converge configurations required to configure a video visit.	-
» appId	string	true	Identifies which instance of the Amwell Converge smart app to be used.	-

putAmwellConfigurations

Name	Type	Required	Description	Accepted Values
sdk	object	false	The Amwell SDK configurations required to configure a video visit.	-
» key	string	true	The key used by the application to interact with the Amwell API.	-
» mobileKey	string	true	The mobile key used by the application to interact with the Amwell API.	-
» apiUrl	string	true	The Amwell API endpoint.	-
enrollment	object	false	The Amwell enrollment configurations required to configure a video visit.	-
» user	string	true	The username used by the application to interact with the Amwell enrollment service.	-
» password	string	true	The password used by the application to interact with the Amwell enrollment service.	-
» url	string	true	The Amwell enrollment service endpoint.	-
converge	object	false	The Amwell Converge configurations required to configure a video visit.	-
» appId	string	true	Identifies which instance of the Amwell Converge smart app to be used.	-

VideoVisitConfigurationSummaries

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

VideoVisits_VideoVisitConfigurationSummary

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the video visit configuration.	-
domain	string	true	The domain name of the patient portal that uses the video visit.	-
widgetImageUrl	string	false	The URL where the widget image is stored.	-
widgetTexts	[VideoVisits_WidgetTextTranslation]	false	The content of the widget text.	-
startPageImageUrl	string	false	The location of the image file to be displayed on the start page of the video visit application.	-
startPageHeading	[VideoVisits_StartPageHeadingTranslation]	false	The heading text to be displayed on the start page of the video visit application.	-
startPageHtml	[VideoVisits_StartPageHtmlTranslation]	false	The HTML content to be displayed on the start page of the video visit application.	-
waitingRoomTexts	[VideoVisits_WaitingRoomTextTranslation]	false	The content of the waiting room.	-
paymentPageUrl	string	false	The location of the file to be embedded in the video visit application to handle credit card information.	-
waitingRoomImageUrl	string	false	The location of the waiting room image file to be embedded in the video visit application. Only one of `waitingRoomImageUrl` or `waitingRoomVideoUrl` may be present.	-
waitingRoomVideoUrl	string	false	The location of the waiting room video file to be embedded in the video visit application. Only one of `waitingRoomImageUrl` or `waitingRoomVideoUrl` may be present.	-
newDependentEnabled	boolean	false	Enable and disable the capability that allows the user to add a new dependent in the On-Demand Video Visit workflow.	-
newDependentDisclaimerTexts	[VideoVisits_NewDependentDisclaimerTranslation]	false	Client’s disclaimer text that the user must acknowledge when adding a new dependent in the On-Demand Video Visit workflow.	-
amwellConfiguration	VideoVisits_AmwellConfiguration	true	The Amwell configuration.	-
healthelifeEnrollmentConfiguration	VideoVisits_HealthelifeEnrollmentConfiguration	false	The HealtheLife enrollment configuration.	-
millenniumEhrConfiguration	VideoVisits_MillenniumEhrConfiguration	true	The Millennium Patient configuration.	-

VideoVisits_WidgetTextTranslation

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
content	string	false	The content of the widget text for a given locale.	-

VideoVisits_StartPageHeadingTranslation

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
content	string	false	The content of the start page heading for a given locale.	-

VideoVisits_StartPageHtmlTranslation

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
content	string	false	The HTML content of the start page for a given locale.	-

VideoVisits_WaitingRoomTextTranslation

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
content	string	false	The content of the waiting room for a given locale.	-

VideoVisits_NewDependentDisclaimerTranslation

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
content	string	false	Client’s disclaimer text that the user must acknowledge when adding a new dependent in the On-Demand Video Visit workflow.	-

VideoVisits_HealthelifeEnrollmentConfiguration

Name	Type	Required	Description	Accepted Values
healthelifeEnrollmentOrgId	string	false	The ID that maps a HealtheLife instance to the video visit application.	-

VideoVisits_MillenniumEhrConfiguration

Name	Type	Required	Description	Accepted Values
millenniumPatientConfiguration	VideoVisits_MillenniumPatientConfiguration	false	The data required by Cerner Millennium to save a patient.	-
millenniumEncounterConfiguration	VideoVisits_MillenniumEncounterConfiguration	false	The Encounter data required by Amwell.	-

VideoVisits_MillenniumPatientConfiguration

Name	Type	Required	Description	Accepted Values
facilityOrganizationId	string	true	The ID of the organization associated with the Cerner Millennium instance that saves an Amwell patient.	-
mrnAliasPoolId	string	true	The ID of the alias pool in Cerner Millennium in which the medical record number of an Amwell patient is saved.	-
mrnAliasTypeCd	string	true	The type code of the alias pool in Cerner Millennium in which the medical record number of an Amwell patient is saved.	-
federatedPrincipalPoolId	string	true	The ID of the alias pool in Cerner Millennium in which the federated principal of an Amwell patient is saved.	-

VideoVisits_MillenniumEncounterConfiguration

Name	Type	Required	Description	Accepted Values
typeCd	string	true	The code of the encounter type.	-
locationId	string	true	The ID of the encounter location.	-
aliasPoolId	string	true	The ID of the alias pool in Cerner Millennium that is used to save Amwell patient encounters.	-
finAliasPoolId	string	true	The ID of the Financial Number alias pool in Cerner Millennium that is used to save Amwell patient encounters.	-
finAliasTypeCd	string	true	The type code of the Financial Number alias pool in Cerner Millennium that is used to save Amwell patient encounters.	-

postVideoVisitConfigurations

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain name of the patient portal that uses the video visit.	-
widgetImageUrl	string	false	The URL where the widget image is stored.	-
widgetTexts	[object]	false	The content of the widget text.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	The content of the widget text for a given locale.	-
startPageImageUrl	string	false	The location of the image file to be displayed on the start page of the video visit application.	-
startPageHeading	[object]	false	The heading text to be displayed on the start page of the video visit application.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	The content of the start page heading for a given locale.	-
startPageHtml	[object]	false	The HTML content to be displayed on the start page of the video visit application.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	The HTML content of the start page for a given locale.	-
waitingRoomTexts	[object]	false	The content of the waiting room.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	The content of the waiting room for a given locale.	-
waitingRoomImageUrl	string	false	The location of the waiting room image file to be embedded in the video visit application. Only one of `waitingRoomImageUrl` or `waitingRoomVideoUrl` may be present.	-
waitingRoomVideoUrl	string	false	The location of the waiting room video file to be embedded in the video visit application. Only one of `waitingRoomImageUrl` or `waitingRoomVideoUrl` may be present.	-
paymentPageUrl	string	false	The location of the file to be embedded in the video visit application to handle credit card information.	-
newDependentEnabled	boolean	false	Enable and disable the capability that allows the user to add a new dependent in the On-Demand Video Visit workflow.	-
newDependentDisclaimerTexts	[object]	false	Client’s disclaimer text that the user must acknowledge when adding a new dependent in the On-Demand Video Visit workflow.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	Client’s disclaimer text that the user must acknowledge when adding a new dependent in the On-Demand Video Visit workflow.	-
amwellConfiguration	object	true	The ID of the Amwell configuration.	-
» id	string	true	The ID of the Amwell configuration.	-
healthelifeEnrollmentConfiguration	object	false	The HealtheLife enrollment configuration.	-
» healthelifeEnrollmentOrgId	string	true	The ID that maps a HealtheLife instance to the video visit application.	-
millenniumEhrConfiguration	object	true	The Millennium Patient configuration.	-
» millenniumPatientConfiguration	object	true	No description	-
»» facilityOrganizationId	string	true	The ID of the organization associated with the Cerner Millennium instance that saves an Amwell patient.	-
»» mrnAliasPoolId	string	true	The ID of the alias pool in Cerner Millennium in which the medical record number of an Amwell patient is saved.	-
»» mrnAliasTypeCd	string	true	The type code of the alias pool in Cerner Millennium in which the medical record number of an Amwell patient is saved.	-
»» federatedPrincipalPoolId	string	true	The ID of the alias pool in Cerner Millennium in which the federated principal of an Amwell patient is saved.	-
» millenniumEncounterConfiguration	object	false	No description	-
»» typeCd	string	true	The code of the encounter type.	-
»» locationId	string	true	The ID of the encounter location.	-
»» aliasPoolId	string	true	The ID of the alias pool in Cerner Millennium that is used to save Amwell patient encounters.	-
»» finAliasPoolId	string	true	The ID of the Financial Number alias pool in Cerner Millennium that is used to save Amwell patient encounters.	-
»» finAliasTypeCd	string	true	The type code of the Financial Number alias pool in Cerner Millennium that is used to save Amwell patient encounters.	-

putVideoVisitConfigurations

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain name of the patient portal that uses the video visit.	-
widgetImageUrl	string	false	The URL where the widget image is stored.	-
widgetTexts	[object]	false	The content of the widget text.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	The content of the widget text for a given locale.	-
startPageImageUrl	string	false	The location of the image file to be displayed on the start page of the video visit application.	-
startPageHeading	[object]	false	The heading text to be displayed on the start page of the video visit application.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	The content of the start page heading for a given locale.	-
startPageHtml	[object]	false	The HTML content to be displayed on the start page of the video visit application.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	The HTML content of the start page for a given locale.	-
waitingRoomTexts	[object]	false	The content of the waiting room.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	The content of the waiting room for a given locale.	-
waitingRoomImageUrl	string	false	The location of the waiting room image file to be embedded in the video visit application. Only one of `waitingRoomImageUrl` or `waitingRoomVideoUrl` may be present.	-
waitingRoomVideoUrl	string	false	The location of the waiting room video file to be embedded in the video visit application. Only one of `waitingRoomImageUrl` or `waitingRoomVideoUrl` may be present.	-
paymentPageUrl	string	false	The location of the file to be embedded in the video visit application to handle credit card information.	-
newDependentEnabled	boolean	false	Enable and disable the capability that allows the user to add a new dependent in the On-Demand Video Visit workflow.	-
newDependentDisclaimerTexts	[object]	false	Client’s disclaimer text that the user must acknowledge when adding a new dependent in the On-Demand Video Visit workflow.	-
» locale	string	true	The locale of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
» content	string	true	Client’s disclaimer text that the user must acknowledge when adding a new dependent in the On-Demand Video Visit workflow.	-
amwellConfiguration	object	true	The ID of the Amwell configuration.	-
» id	string	true	The ID of the Amwell configuration.	-
healthelifeEnrollmentConfiguration	object	false	The HealtheLife enrollment configuration.	-
» healthelifeEnrollmentOrgId	string	true	The ID that maps a HealtheLife instance to the video visit application.	-
millenniumEhrConfiguration	object	true	The Millennium Patient configuration.	-
» millenniumPatientConfiguration	object	true	No description	-
»» facilityOrganizationId	string	true	The ID of the organization associated with the Cerner Millennium instance that saves an Amwell patient.	-
»» mrnAliasPoolId	string	true	The ID of the alias pool in Cerner Millennium in which the medical record number of an Amwell patient is saved.	-
»» mrnAliasTypeCd	string	true	The type code of the alias pool in Cerner Millennium in which the medical record number of an Amwell patient is saved.	-
»» federatedPrincipalPoolId	string	true	The ID of the alias pool in Cerner Millennium in which the federated principal of an Amwell patient is saved.	-
» millenniumEncounterConfiguration	object	false	No description	-
»» typeCd	string	true	The code of the encounter type.	-
»» locationId	string	true	The ID of the encounter location.	-
»» aliasPoolId	string	true	The ID of the alias pool in Cerner Millennium that is used to save Amwell patient encounters.	-
»» finAliasPoolId	string	true	The ID of the Financial Number alias pool in Cerner Millennium that is used to save Amwell patient encounters.	-
»» finAliasTypeCd	string	true	The type code of the Financial Number alias pool in Cerner Millennium that is used to save Amwell patient encounters.	-

AppointmentTypes

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

PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypes_AppointmentType

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific appointment type.	-
millenniumAppointmentTypes	PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypes_AppointmentTypeReference	false	An array of Cerner Millennium appointment types.	-

PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypes_AppointmentTypeReference

Name	Type	Required	Description	Accepted Values
synonymCode	string	false	The Cerner Millennium appointment synonym code.	-

postAppointmentTypes

Name	Type	Required	Description	Accepted Values
millenniumAppointmentTypes	[object]	true	An array of Cerner Millennium appointment types.	-
» synonymCode	string	true	The ID of the Cerner Millennium OAuth configuration.	-

AppointmentTypeConfigs

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

PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypeConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the appointment type configuration.	-
appointmentTypeId	string	true	The appointment type ID to be associated with a domain.	-
domainName	string	true	The name of the domain.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

postAppointmentTypeConfigs

Name	Type	Required	Description	Accepted Values
appointmentTypeId	string	true	The appointment type ID you want to associate with a domain.	-
domainName	string	true	The name of the domain.	-

putAppointmentTypeConfigs

Name	Type	Required	Description	Accepted Values
appointmentTypeId	string	true	The appointment type ID you want to associate with a domain.	-
domainName	string	true	The name of the domain.	-

WellnessDomainOrgMappings

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

PatientPortalApplicationPublicApi_Entities_V1_WellnessDomainOrgMapping

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the Wellness domain organization mapping.	-
millenniumOrgId	string	true	The ID of a Cerner Millennium organization.	-
domainName	string	true	The domain of the Wellness application.	-
createdAt	string	false	The date and time when the resource was created.	-
updatedAt	string	false	The date and time when the resource was updated.	-

postWellnessDomainOrgMappings

Name	Type	Required	Description	Accepted Values
millenniumOrgId	string	true	The ID of a Cerner Millennium organization.	-
domainName	string	true	The domain of the Wellness application.	-

putWellnessDomainOrgMappings

Name	Type	Required	Description	Accepted Values
millenniumOrgId	string	true	The ID of a Cerner Millennium organization.	-
domainName	string	true	The domain of the Wellness application.	-

GetActivityLogs

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

PatientPortalApplicationPublicApi_Entities_V1_ActivityLogs_GetActivityLog

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the activity log.	-
patientPortalPersonId	string	true	The Cerner Millennium ID of the patient in the patient portal application on whose EHR the actions are performed.	-
personIdentifier	string	true	The ID of the patient on whose EHR the actions are performed in the health record feature, for example, a medical record number (MRN) alias.	-
identifierType	string	true	The Cerner Millennium alias type of the patient in the patient portal application on whose EHR the actions are performed.	-
featureDetail	string	false	The details about the feature. For example, if `MICROBIOLOGY` is a feature, the name of the microbiology report is the feature detail.	-
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application.	-
createdAt	string	true	The date and time in UTC when the resource was created.	-
featureDisplay	string	true	The display name of the feature in the patient portal application based on the locale.	-
actionDisplay	string	true	The display name of the activity performed in the health record feature based on the locale.	-
actionByName	PatientPortalApplicationPublicApi_Entities_V1_ActivityLogs_ActionByNameEntity	true	No description	-

PatientPortalApplicationPublicApi_Entities_V1_ActivityLogs_ActionByNameEntity

Name	Type	Required	Description	Accepted Values
formatted	string	true	The formatted name of the user logged in to the patient portal application who performed the action on an EHR.	-
first	string	true	The first name of the user logged in to the patient portal application who performed the action on an EHR.	-
last	string	true	The last name of the user logged in to the patient portal application who performed the action on an EHR.	-

postActivityLogs

Name	Type	Required	Description	Accepted Values
patientPortalPersonId	string	false	The Cerner Millennium ID of the patient in the patient portal application on whose electronic health record (EHR) the actions are performed.	-
personIdentifier	string	false	The Cerner Millennium alias of the patient in the patient portal application on whose EHR the actions are performed.	-
identifierType	string	true	The Cerner Millennium alias type of the patient in the patient portal application on whose EHR the actions are performed.	-
feature	string	true	The name of the feature in the patient portal application where the action was performed.	-
featureDetail	string	false	The details about the feature. For example, if `MICROBIOLOGY` is a feature, the name of the microbiology report is the feature detail.	-
action	string	true	The action performed in the health record feature in the patient portal application.	-
actionBy	string	true	The person ID of the user logged in to the patient portal application who performed the action on an EHR, for example, the principal URI.	-
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application.	-

PatientPortalApplicationPublicApi_Entities_V1_ActivityLogs_PostActivityLog

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the activity log.	-
patientPortalPersonId	string	true	The Cerner Millennium ID of the patient in the patient portal application on whose EHR the actions are performed.	-
personIdentifier	string	true	The ID of the patient on whose EHR the actions are performed in the health record feature, for example, a medical record number (MRN) alias.	-
identifierType	string	true	The Cerner Millennium alias type of the patient in the patient portal application on whose EHR the actions are performed.	-
featureDetail	string	false	The details about the feature. For example, if `MICROBIOLOGY` is a feature, the name of the microbiology report is the feature detail.	-
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application.	-
createdAt	string	true	The date and time in UTC when the resource was created.	-
feature	string	true	The name of the feature in the patient portal application where the action was performed.	-
action	string	true	The action performed in the health record feature in the patient portal application.	-
actionBy	string	true	The person ID of the user logged in to the patient portal application who performed the action on an EHR, for example, the principal URI.	-

PolicyTexts

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

PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_PolicyText

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_LocaleTextsEntity]	true	The locale and text for the locale.	-

PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_LocaleTextsEntity

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

postActivityLogsPolicyTexts

Name	Type	Required	Description	Accepted Values
localeTexts	[object]	true	The locale of the policy text.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

GetPolicyTextConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_GetPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyText	PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_PolicyTextsReference	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_PolicyTextsReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_LocaleTextsEntity]	true	The locale and text for the locale.	-

postActivityLogsPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_PostPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

putActivityLogsPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PatientPortalConfigurations

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

PatientPortalConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the patient portal configuration.	-
domainName	string	true	The domain associated with the patient portal configuration.	-
unauthExperienceEnabled	boolean	false	Indicates whether the unauthenticated experience is enabled for the patient portal. The unauthenticated experience allows users to have patient portal experiences without logging in.	-
assigningAuthorities	AssigningAuthority	false	The assigning authorities associated with this domain.	-
signInRedirect	string	false	The web address to which the user is redirected upon log-in.	-
customHeaders	CustomHeader	false	The custom header associated with this domain.	-
useMessagingNotificare	boolean	false	Indicates to the patient portal whether Notificare needs to request the messaging resources of the Health Data Intelligence Consumer Engagement API v1.	-
useSchedulingNotificare	boolean	false	Indicates to the patient portal whether Notificare needs to request the scheduling resources of HealtheLife Millennium Scheduling Services.	-
usesLogoutRedirect	boolean	false	Indicates whether the patient portal uses the log-out redirect. The log-out redirect allows sites to display an explicit log-out message after users log out.	-
skipConsumerFlowEnabled	boolean	false	Indicates whether the patient portal skips the consumer workflow.	-
millenniumAliasLookupEnabled	boolean	false	Indicates whether the Cerner Millennium alias lookup workflow is enabled.	-

AssigningAuthority

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the assigning authority.	aetna_member, aetna_subscriber, member, mrn, subscriber
assigningAuthority	string	true	The assigning authority	-

CustomHeader

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the custom header.	-
title	string	true	The title of the custom header.	-
url	string	true	The pagelet web address for the custom header.	-

postPatientPortalConfigurations

Name	Type	Required	Description	Accepted Values
domainName	string	true	The domain associated with the patient portal configuration.	-
unauthExperienceEnabled	string	false	Indicates whether the unauthenticated experience is enabled for the patient portal. The unauthenticated experience allows users to have patient portal experiences without logging in.	-
signInRedirect	string	false	The web address to which the user is redirected upon log-in.	-
useMessagingNotificare	boolean	false	Indicates to the patient portal whether Notificare needs to request the messaging resources of the Health Data Intelligence Consumer Engagement API v1.	-
useSchedulingNotificare	boolean	false	Indicates to the patient portal whether Notificare needs to request the scheduling resources of HealtheLife Millennium Scheduling Services.	-
usesLogoutRedirect	string	false	Indicates whether the patient portal uses the log-out redirect. The log-out redirect allows sites to display an explicit log-out message after users log out.	-
skipConsumerFlowEnabled	string	false	Indicates whether the patient portal skips the consumer workflow.	-
millenniumAliasLookupEnabled	string	false	Indicates whether the Cerner Millennium alias lookup workflow is enabled.	-
customHeaders	[CustomHeader]	false	The custom header associated with this domain.	-
assigningAuthorities	[AssigningAuthority]	false	The assigning authorities associated with this domain.	-

postConsumerEnrollments

Name	Type	Required	Description	Accepted Values
domainUri	string	true	The domain URI of a patient portal application website.	-
consumer	object	true	The consumer enrolling as a patient or as a caretaker for a different person in a patient portal application.	-
» id	string	true	The ID of the enrolling consumer.	-
» principalAlias	string	true	A principal alias is a business identifier that distinguishes a user across multiple realms. It is comprised of a realm ID, which is the authority responsible for assigning the identifier, and a principal, which is the value or identifier in the context of the assigning authority.	-
» millenniumPatientId	string	true	The Cerner Millennium patient ID of the consumer.	-
person	object	false	The person being enrolled in the patient portal application. The consumer is acting as a caretaker for this person if this value is present. A caretaker can be a parent, guardian, or authorized representative responsible for managing the health of the person.	-
» millenniumPatientId	string	true	The Cerner Millennium patient ID of the person being enrolled by the consumer.	-

ConsumerEnrollment

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the created consumer enrollment.	-
consumer	EnrolledConsumer	true	The enrolled consumer.	-
createdAt	string(date)	true	The date and time when the consumer was enrolled, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format.	-

EnrolledConsumer

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

postConsumerEnrollmentConfigurations

Name	Type	Required	Description	Accepted Values
fpaPoolCode	integer(int32)	true	The code that identifies the federated principal alias pool in Cerner Millennium.	-
messagingAliasPoolCode	integer(int32)	true	The code that identifies the messaging alias pool in Cerner Millennium.	-
millenniumDataPartitionId	string	true	The Health Data Intelligence data partition ID in which consumers should be enrolled.	-
isMillenniumRelationship	boolean	true	Indicates whether Cerner Millennium is the source of truth for consumer enrollment informations.	-
existingPatientWorkflowEnabled	boolean	false	Turns on a sequence of steps that determine whether the patient already exists in a given domain. This value defaults to False.	-
previousCareReceivedPromptTitle	[object]	false	The custom title for the UI element prompting the patient to indicate whether they have previously received care from the provider. A value if needed only if you want to overwrite the default value.	-
previousCareReceivedPromptDescription	[object]	false	The custom description for the UI element prompting the patient to indicate whether they have previously received care from the provider. A value is needed only if you want to overwrite the default value.	-

ConsumerEnrollmentConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the consumer enrollment configuration.	-
fpaPoolCode	integer(int32)	true	The code that identifies the federated principal alias pool in Cerner Millennium.	-
messagingAliasPoolCode	integer(int32)	true	The code that identifies the messaging alias pool in Cerner Millennium.	-
millenniumDataPartitionId	string	true	The Health Data Intelligence data partition ID in which consumers should be enrolled.	-
isMillenniumRelationship	boolean	true	Indicates whether Cerner Millennium is the source of truth for consumer enrollment informations.	-
usesHealthelifePortal	boolean	false	Indicates whether a HealtheLife portal is available for the environment.	-
existingPatientWorkflowEnabled	boolean	false	Turns on a sequence of steps that determine whether the patient already exists in a given domain. Defaults to a False value.	-
previousCareReceivedPromptTitle	PreviousCareReceivedPromptTitle	false	The custom title for the UI element that prompts the patient to indicate whether they have previously received care from the provider. The value of this field overwrites the default value.	-
previousCareReceivedPromptDescription	PreviousCareReceivedPromptDescription	false	The custom description for the UI element that prompts the patient to indicate whether they have previously received care from the provider. The value of this field overwrites the default value.	-

PreviousCareReceivedPromptTitle

Name	Type	Required	Description	Accepted Values
locale	string	false	The region of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
text	string	false	The custom title for the UI element that prompts the patient to indicate whether they have previously received care from the provider. This value overwrites the default value.	-

PreviousCareReceivedPromptDescription

Name	Type	Required	Description	Accepted Values
locale	string	false	The region of the translation. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by a hyphen.	-
text	string	false	The custom description for the UI element that prompts the patient to indicate whether they have previously received care from the provider. The value of this field overwrites the default value.	-

ConsumerEnrollmentConfigs

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

postConsumerEnrollmentSiteConfigurations

Name	Type	Required	Description	Accepted Values
domainUri	string	true	The domain URI of the patient portal site associated with the consumer enrollment site configuration.	-
enrollmentConfiguration	object	true	The associated consumer enrollment configuration.	-
» id	string	true	The ID of the consumer enrollment site configuration.	-

ConsumerEnrollmentSiteConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the consumer enrollment site configuration.	-
domainUri	string	true	The domain URI of the patient portal site associated with the consumer enrollment site configuration.	-
enrollmentConfiguration	ConsumerEnrollmentConfig	true	The associated consumer enrollment configuration.	-

ConsumerEnrollmentSiteConfigs

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

putConsumerEnrollmentSiteConfigurations

Name	Type	Required	Description	Accepted Values
domainUri	string	true	The domain URI of the patient portal site associated with the consumer enrollment site configuration.	-
enrollmentConfiguration	object	true	The associated consumer enrollment configuration.	-
» id	string	true	The ID of the associated consumer enrollment configuration.	-

postAppointmentNotificationRecords

Name	Type	Required	Description	Accepted Values
patient	object	true	The details associated with the patient	-
» id	string	true	No description	-
» name	string	true	No description	-
» phoneNumbers	[object]	true	No description	-
»» type	string	false	No description	-
»» number	string	true	No description	-
»» priority	string	false	No description	-
provider	object	true	The details associated with a provider	-
» id	string	true	The ID associated with the provider with whom the appointment is scheduled.	-
visit	object	true	The details associated with a visit	-
» id	string	true	No description	-
» startDateTime	string	true	No description	-
» duration	string	true	No description	-
» language	string	false	No description	-

PatientPortalApplicationPublicApi_Entities_V1_AppointmentNotifications_AppointmentNotificationRecordSummary

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the appointment notification record.	-
patient	PatientPortalApplicationPublicApi_Entities_V1_AppointmentNotifications_Patient	true	The details associated with the patient	-
provider	PatientPortalApplicationPublicApi_Entities_V1_AppointmentNotifications_Provider	true	The details associated with a provider	-
visit	PatientPortalApplicationPublicApi_Entities_V1_AppointmentNotifications_Visit	true	The details associated with a visit	-

PatientPortalApplicationPublicApi_Entities_V1_AppointmentNotifications_Patient

Name	Type	Required	Description	Accepted Values
id	string	true	The ID associated with the patient.	-
name	string	false	The name of the patient receiving the notification.	-
phoneNumbers	[PatientPortalApplicationPublicApi_Entities_V1_AppointmentNotifications_Phones]	true	An array of phone numbers of the patients in Cerner Millennium.	-

PatientPortalApplicationPublicApi_Entities_V1_AppointmentNotifications_Phones

Name	Type	Required	Description	Accepted Values
type	string	true	The type of phone number.	PERSONAL, HOME, WORK
number	string	true	The numbers associated with the phone number.	-
priority	integer(int32)	false	The numeric value that determines the priority or precedence that a phone number of one type has over another phone number of the same type.	-

PatientPortalApplicationPublicApi_Entities_V1_AppointmentNotifications_Provider

Name	Type	Required	Description	Accepted Values
id	string	true	The ID associated with the provider with whom the appointment is scheduled.	-

PatientPortalApplicationPublicApi_Entities_V1_AppointmentNotifications_Visit

Name	Type	Required	Description	Accepted Values
id	string	true	The ID associated with the appointment for which the patient is being notified.	-
startDateTime	string	true	The time at which the appointment starts.	-
duration	string	true	The duration of time in minutes for the scheduled appointment.	-
language	string	false	The language for the scheduled appointment.	-

InfoButtonConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_InfoButtonConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the Infobutton configuration.	-
educationContentUrl	string	true	The URL of the page that provides more information.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

postImmunizationsInfoButtonConfigurations

Name	Type	Required	Description	Accepted Values
educationContentUrl	string	true	The URL of the page that provides more information.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

putImmunizationsInfoButtonConfigurations

Name	Type	Required	Description	Accepted Values
educationContentUrl	string	true	The URL of the page that provides more information.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

AllConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_AllConfigurations

Name	Type	Required	Description	Accepted Values
policyTextConfiguration	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetPolicyTextConfiguration	false	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-
knowledgeBaseConfiguration	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetKnowledgeBaseConfiguration	false	The knowledge base configuration associated with the Health Data Intelligence tenant.	-
logoConfiguration	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetLogoConfiguration	false	The unique ID of the logo associated with the Health Data Intelligence tenant.	-
addressConfiguration	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetAddressConfiguration	false	The unique ID of the address associated with the Health Data Intelligence tenant.	-
dataSourceConfiguration	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_DataSourceConfiguration	false	The data source configuration associated with the Health Data Intelligence tenant.	-
adolescentDataFlagConfiguration	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_AdolescentDataFlagConfig	false	The adolescent data flag configuration associated with the Health Data Intelligence tenant.	-
infoButtonConfiguration	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_InfoButtonConfiguration	false	The Infobutton configuration associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyText	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_PolicyTextsReference	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_PolicyTextsReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleTextsEntity]	true	An array of locales and texts.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleTextsEntity

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetKnowledgeBaseConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
knowledgeBase	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_KnowledgeBasesReference	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_KnowledgeBasesReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text.	-
facilityCd	string	true	The code value of the facility of the tenant that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
localeCodes	[PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleCodesEntity]	true	An array of locales and codes.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleCodesEntity

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the knowledge base.	-
code	string	true	The code of the knowledge base’s locale.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetLogoConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the logo configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
logo	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LogosReference	true	The unique ID of the logo associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LogosReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the logo.	-
url	string	true	The URL of the tenant’s logo.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetAddressConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the address configuration associated with the Health Data Intelligence tenant	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
address	PatientPortalApplicationPublicApi_Entities_V1_Immunizations_AddressesReference	true	The unique ID of the address associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_AddressesReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the address.	-
localeAddresses	[PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleAddressesEntity]	true	The lines of the address.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleAddressesEntity

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the address.	-
line1	string	true	Line one of the tenant’s address.	-
line2	string	false	Line two of the tenant’s address.	-
line3	string	false	Line three of the tenant’s address.	-
line4	string	false	Line four of the tenant’s address.	-
line5	string	false	Line five of the tenant’s address.	-
line6	string	false	Line six of the tenant’s address.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_DataSourceConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the data source configuration.	-
dataSource	string	true	The data source is an enumerated value. The following values are supported: `MILLENNIUM` and `HEALTHEINTENT`.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_AdolescentDataFlagConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the adolescent data flag configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
enabled	boolean	true	Indicates whether the adolescent data flag is enabled.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

DataSourceConfigurations

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

postImmunizationsDataSourceConfigurations

Name	Type	Required	Description	Accepted Values
dataSource	string	true	The data source is an enumerated value. The following values are supported: `HEALTHEINTENT` and `MILLENNIUM`.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

putImmunizationsDataSourceConfigurations

Name	Type	Required	Description	Accepted Values
dataSource	string	true	The data source is an enumerated value. The following values are supported: `HEALTHEINTENT` and `MILLENNIUM`.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

KnowledgeBases

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

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_KnowledgeBase

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant	-
facilityCd	string	true	The code value of facility of the tenant that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
localeCodes	[PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleCodesEntity]	true	An array of locales and codes.	-

postImmunizationsKnowledgeBases

Name	Type	Required	Description	Accepted Values
localeCodes	[object]	true	The locale of the knowledge base.	-
» locale	string	true	The locale of the knowledge base.	-
» code	string	true	The locale code for the tenant.	-

GetKnowledgeBaseConfigurations

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

postImmunizationsKnowledgeBaseConfigurations

Name	Type	Required	Description	Accepted Values
knowledgeBaseId	string	true	The unique ID for the knowledge base associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_PostKnowledgeBaseConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
knowledgeBaseId	string	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant.	-

putImmunizationsKnowledgeBaseConfigurations

Name	Type	Required	Description	Accepted Values
knowledgeBaseId	string	true	The unique ID for the knowledge base associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

AdolescentDataFlagConfigs

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

postImmunizationsAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
enabled	boolean	true	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-

putImmunizationsAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
enabled	boolean	true	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-

Addresses

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

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_Address

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the address associated with the Health Data Intelligence tenant	-
localeAddresses	[PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleAddressesEntity]	true	The lines of the address.	-

postImmunizationsAddresses

Name	Type	Required	Description	Accepted Values
localeAddresses	[object]	true	The locale of the address.	-
» locale	string	true	The locale of the address.	-
» line1	string	true	Line one of the tenant’s address.	-
» line2	string	false	Line two of the tenant’s address.	-
» line3	string	false	Line three of the tenant’s address.	-
» line4	string	false	Line four of the tenant’s address.	-
» line5	string	false	Line five of the tenant’s address.	-
» line6	string	false	Line six of the tenant’s address.	-

GetAddressConfigurations

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

postImmunizationsAddressConfigurations

Name	Type	Required	Description	Accepted Values
addressId	string	true	The unique ID for the address associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_PostAddressConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the address configuration associated with the Health Data Intelligence tenant	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
addressId	string	true	The unique ID of the address associated with the Health Data Intelligence tenant.	-

putImmunizationsAddressConfigurations

Name	Type	Required	Description	Accepted Values
addressId	string	true	The unique ID for the address associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

Logos

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

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_Logo

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the logo.	-
url	string	true	The URL of the tenant’s logo.	-

postImmunizationsLogos

Name	Type	Required	Description	Accepted Values
url	string	true	The URL link of the logo of the tenant.	-

GetLogoConfigurations

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

postImmunizationsLogoConfigurations

Name	Type	Required	Description	Accepted Values
logoId	string	true	The unique ID of the logo associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_PostLogoConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the logo configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
logoId	string	true	The unique ID of the logo associated with the Health Data Intelligence tenant.	-

putImmunizationsLogoConfigurations

Name	Type	Required	Description	Accepted Values
logoId	string	true	The unique ID of the logo associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

postImmunizationsPolicyTexts

Name	Type	Required	Description	Accepted Values
localeTexts	[object]	true	The locale of the policy text.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_PolicyText

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleTextsEntity]	true	An array of locales and texts.	-

postImmunizationsPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_PostPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

putImmunizationsPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

Configurations

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

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_Configurations

Name	Type	Required	Description	Accepted Values
policyTextConfiguration	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_GetPolicyTextConfiguration	false	The policy text configuration associated with the Health Data Intelligence tenant.	-
knowledgeBaseConfiguration	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_GetKnowledgeBaseConfiguration	false	The knowledge base configuration associated with the Health Data Intelligence tenant.	-
commentsConfiguration	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_CommentsConfiguration	false	The comments configuration associated with the Health Data Intelligence tenant.	-
dataSourceConfiguration	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_DataSourceConfiguration	false	The data source configuration associated with the Health Data Intelligence tenant.	-
adolescentDataFlagConfiguration	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_AdolescentDataFlagConfig	false	The adolescent data flag configuration associated with the Health Data Intelligence tenant.	-
infoButtonConfiguration	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_InfoButtonConfiguration	false	The Infobutton configuration associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_GetPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyText	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_PolicyTextsReference	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_PolicyTextsReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_LocaleTextsEntity]	true	The locale and text.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_LocaleTextsEntity

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the policy text.	-
text	string	false	The policy text in the locale for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_GetKnowledgeBaseConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base configuration associated with the Health Data Intelligence tenant	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
knowledgeBase	PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_KnowledgeBasesReference	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_KnowledgeBasesReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base.	-
facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
localeCodes	[PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_LocaleCodesEntity]	true	The locale and code.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_LocaleCodesEntity

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the knowledge base.	-
code	string	false	The locale code of the knowledge base for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_CommentsConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the comments configuration.	-
enabled	boolean	true	Indicates whether the comments are enabled.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_DataSourceConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the data source configuration.	-
dataSource	string	true	The data source is an enumerated value. The following values are supported: `MILLENNIUM` and `HEALTHEINTENT`.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_AdolescentDataFlagConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the adolescent data flag configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
enabled	boolean	true	Indicates whether the adolescent data flag is enabled.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_InfoButtonConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the Infobutton configuration.	-
educationContentUrl	string	true	The URL of the page that provides more information.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

postAllergiesInfoButtonConfigurations

Name	Type	Required	Description	Accepted Values
educationContentUrl	string	true	The URL of the page that provides more information.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

putAllergiesInfoButtonConfigurations

Name	Type	Required	Description	Accepted Values
educationContentUrl	string	true	The URL of the page that provides more information.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

postAllergiesAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
enabled	boolean	true	Indicates whether adolescent data flag is enabled for the tenant’s environment.	-

putAllergiesAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
enabled	boolean	true	Indicates whether adolescent data flag is enabled for the tenant’s environment.	-

postAllergiesDataSourceConfigurations

Name	Type	Required	Description	Accepted Values
dataSource	string	true	The data source is an enumerated value. The following values are supported: `HEALTHEINTENT` and `MILLENNIUM`.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

putAllergiesDataSourceConfigurations

Name	Type	Required	Description	Accepted Values
dataSource	string	true	The data source is an enumerated value. The following values are supported: `HEALTHEINTENT` and `MILLENNIUM`.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

CommentsConfigurations

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

postAllergiesCommentsConfigurations

Name	Type	Required	Description	Accepted Values
enabled	boolean	true	Indicates whether comments are enabled for the tenant’s environment.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

putAllergiesCommentsConfigurations

Name	Type	Required	Description	Accepted Values
enabled	boolean	true	Indicates whether comments are enabled for the tenant’s environment.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

postAllergiesKnowledgeBases

Name	Type	Required	Description	Accepted Values
localeCodes	[object]	true	The locale of the knowledge base.	-
» locale	string	true	The locale of the knowledge base.	-
» code	string	true	The locale code for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_KnowledgeBase

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant	-
facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
localeCodes	[PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_LocaleCodesEntity]	true	The locale and code.	-

postAllergiesKnowledgeBaseConfigurations

Name	Type	Required	Description	Accepted Values
knowledgeBaseId	string	true	The unique ID for the knowledge base associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_PostKnowledgeBaseConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base configuration associated with the Health Data Intelligence tenant	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
knowledgeBaseId	string	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant.	-

putAllergiesKnowledgeBaseConfigurations

Name	Type	Required	Description	Accepted Values
knowledgeBaseId	string	true	The unique ID for the knowledge base associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

postAllergiesPolicyTexts

Name	Type	Required	Description	Accepted Values
localeTexts	[object]	true	The locale of the policy text.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_PolicyText

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_LocaleTextsEntity]	true	The locale and text.	-

postAllergiesPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_PostPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

putAllergiesPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PolicyTextDefinitions

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

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyTextDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the policy text definition.	-
policyTexts	[PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_LocaleTextsEntity]	true	A list of policy texts.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_LocaleTextsEntity

Name	Type	Required	Description	Accepted Values
policyTextType	string	true	The policy text type that is displayed in a specific view.	-
locale	string	true	The locale of the policy text definition.	-
text	string	true	The policy text.	-

postSchedulingPolicyTextDefinitions

Name	Type	Required	Description	Accepted Values
policyTexts	[object]	true	The list of policy text definitions.	-
» policyTextType	string	true	The policy text type that is displayed on a specific view. The following values are accepted: `APPOINTMENT_LIST`, `REQUEST_APPOINTMENT`, `APPOINTMENT_SLOTS`, `APPOINTMENT_DIRECT_CANCEL`, `CANCELLATION_DEADLINE`, `APPOINTMENT_CANCELLATION`, `REQUEST_APPOINTMENT_CONFIRMATION`, `NPA_REQUEST`, `NPA_PROFILE_CREATION`, `VIRTUAL_HEALTH`, `PROVIDER_LABEL`, `REQUEST_APPOINTMENT_VIA_MESSAGE`, `APPOINTMENT_CANCELLATION_VIA_MESSAGE`, `RESCHEDULE_APPOINTMENT_VIA_MESSAGE`, `APPOINTMENT_TYPE`, `DIRECT_BOOK_ADDITIONAL_COMMENTS` and `REQUEST_SCHEDULING_ADDITIONAL_COMMENTS`	-
» locale	string	true	The locale of the policy text definition.	-
» text	string	true	The policy text.	-

PolicyTextConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the policy text configuration.	-
policyTextDefinition	PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyConfigurationEntity	true	A list of policy texts.	-
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyConfigurationEntity

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the policy text configuration.	-
policyTexts	[PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_LocaleTextsEntity]	true	A list of policy texts.	-

postSchedulingPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextDefinitionId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The domain with which the policy text is associated.	-

putSchedulingPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextDefinitionId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The domain with which the policy text is associated.	-

FeatureDefinitions

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

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_FeatureDefinition

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the feature definition.	-
cancellationDeadline	string	false	The number of hours prior to which an appointment can be canceled.	-
directBookEnabled	boolean	false	Indicates whether patients can use the guided scheduling feature to schedule a new appointment type, select an appointment type they previously scheduled, or choose from a list of commonly scheduled appointment types.	-
useLegacyDirectBook	boolean	false	Indicates whether legacy direct book workflows are enabled.	-
guidedSchedulingEnabled	boolean	false	Indicates whether patients can use the guided scheduling feature to schedule a new appointment type, select an appointment type they have previously scheduled, or choose from a list of commonly scheduled appointment types.	-
requestSchedulingViaQueueEnabled	boolean	false	Indicates whether patients can send a secure message to request an appointment that is then scheduled based on a queue system.	-
directBookAppointmentDelay	string	false	The number of hours configured for a direct book appointment delay.	-
requestRescheduleEnabled	boolean	false	Indicates whether users can request to reschedule an appointment.	-
geoLocationEnabled	boolean	false	Indicates whether a patient can view information about a location, such as a patient-friendly name or the location phone number and address.	-
videoVisitVendor	string	false	The video visit vendor. The value can be `VYOPTA` or `AMWELL`.	-
requestCancelViaMessageEnabled	boolean	false	Indicates whether users can send a message to request cancellation.	-
appointmentBookingThreshold	string	false	The number of appointments that can be booked per day.	-
requestSchedulingViaMessageEnabled	boolean	false	Indicates whether users can send a message to request rescheduling.	-
directCancelEnabled	boolean	false	Indicates whether direct cancellation is enabled.	-
directRescheduleEnabled	boolean	false	Indicates whether patients can directly reschedule an appointment.	-
npaAuthUsersEnabled	boolean	false	Indicates whether new patients can send a message to request rescheduling in an authenticated user workflow.	-
npaUnauthUsersEnabled	boolean	false	Indicates whether new patients can send a message to request rescheduling in an unauthenticated user workflow.	-
npaPortalAccountEnabled	boolean	false	Indicates whether consumers can create a Cerner Health account or patient portal account before they schedule an appointment. This feature can be enabled or disabled for each tenant.	-
npaSsnEnabled	boolean	false	Indicates whether a Social Security number (SSN) is enabled on the patient details page for new patient appointments.	-
directBookContactViaPhoneEnabled	boolean	false	Indicates whether portal users can call a phone contact option to directly book an appointment.	-
directBookContactViaMessageEnabled	boolean	false	Indicates whether portal users can send a secure message option to directly book an appointment.	-
npaPortalAccountMinAge	string	false	The minimum age value for Cerner Health accounts or patient portal accounts.	-
npaSsnAliasPoolCode	string	false	The SSN alias pool code that is used to store patient SSNs	-
facilityOrganizationId	string	false	The unique ID of the facility where patient registration is performed for new patient appointments.	-
npaRequestSchedulingEnabled	boolean	false	Indicates whether the request scheduling workflow is enabled or disabled for new patient appointments.	-
clipboardsEnabled	boolean	false	Indicates whether the request clipboards workflow is enabled or disabled.	-
domain	string	false	The base legacy portal URL for building legacy redirects.	-
videoVisitsEnabled	boolean	false	Indicates whether video visits are enabled for a client.	-
amwellAppId	string	false	The App Id for launching an Amwell Scheduled Video Visit. Only needed when a client is using Amwell as the vendor and they need a different App Id than the default.	-
legacyRequestWorkflowsEnabled	boolean	false	Indicates whether legacy request scheduling workflows are enabled for a client.	-
bookByProviderEnabled	boolean	false	Indicates whether book by provider scheduling workflows are enabled for a client.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

postSchedulingFeatureDefinitions

Name	Type	Required	Description	Accepted Values
videoVisitVendor	string	false	The video visit vendor. The value can be `VYOPTA` or `AMWELL`.	-
cancellationDeadline	string	false	The number of hours prior to which an appointment can be canceled.	-
appointmentBookingThreshold	string	false	The number of appointments that can be booked per day.	-
requestSchedulingViaMessageEnabled	boolean	false	Indicates whether users can send a message to request rescheduling.	-
requestSchedulingViaQueueEnabled	boolean	false	Indicates whether patients can send a secure message to request an appointment that is then scheduled based on a queue system.	-
directBookEnabled	boolean	false	Indicates whether patients can find available times for a specific appointment type, provider, or specialty and then directly book an appointment.	-
useLegacyDirectBook	boolean	false	Indicates whether legacy direct book workflows are enabled.	-
guidedSchedulingEnabled	boolean	false	Indicates whether patients can use the guided scheduling feature to schedule a new appointment type, select an appointment type they previously scheduled, or select from a list of commonly scheduled appointment types.	-
geoLocationEnabled	boolean	false	Indicates whether a patient can view information about a location, such as a patient-friendly name or the location phone number and address.	-
requestCancelViaMessageEnabled	boolean	false	Indicates whether users can send a message to request cancellation.	-
directBookAppointmentDelay	string	false	The number of hours configured for a direct book appointment delay.	-
requestRescheduleEnabled	boolean	false	Indicates whether users can request to reschedule an appointment.	-
directCancelEnabled	boolean	false	Indicates whether direct cancellation is enabled.	-
directRescheduleEnabled	boolean	false	Indicates whether patients can directly reschedule an appointment.	-
npaAuthUsersEnabled	boolean	false	Indicates whether new patients can send a message to request rescheduling in an authenticated user workflow.	-
npaUnauthUsersEnabled	boolean	false	Indicates whether new patients can send a message to request rescheduling in an unauthenticated user workflow.	-
npaPortalAccountEnabled	boolean	false	Indicates whether consumers can create a Cerner Health account or patient portal account before they schedule an appointment. This setting can be enabled or disabled by tenants.	-
npaSsnEnabled	boolean	false	Indicates whether a Social Security number (SSN) is enabled on the patient details page for new patient appointments.	-
directBookContactViaPhoneEnabled	boolean	false	Indicates whether portal users can call a phone contact option to directly book an appointment.	-
directBookContactViaMessageEnabled	boolean	false	Indicates whether portal users can send a secure message option to directly book an appointment.	-
npaPortalAccountMinAge	string	false	The minimum age value for Cerner Health accounts or patient portal accounts.	-
npaSsnAliasPoolCode	string	false	The Social Security number (SSN) alias pool code that is used to store patient SSNs.	-
facilityOrganizationId	string	false	The unique ID of the facility where patient registration is performed for new patient appointments.	-
npaRequestSchedulingEnabled	boolean	false	Indicates whether the request scheduling workflow is enabled or disabled for new patient appointments.	-
clipboardsEnabled	boolean	false	Indicates whether the request clipboards workflow is enabled or disabled.	-
domain	string	false	The base legacy portal URL for building legacy redirects.	-
videoVisitsEnabled	boolean	false	Indicates whether video visits are enabled for a client.	-
amwellAppId	string	false	The App Id for launching an Amwell Scheduled Video Visit. Only needed when a client is using Amwell as the vendor and they need a different App Id than the default.	-
legacyRequestWorkflowsEnabled	boolean	false	Indicates whether legacy request scheduling workflows are enabled for a client.	-
bookByProviderEnabled	boolean	false	Indicates whether book by provider scheduling workflows are enabled for a client.	-

FeatureConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_FeatureConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the feature configuration.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
featureDefinition	PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_FeatureConfigurationEntity	true	The feature definition entity.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_FeatureConfigurationEntity

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the feature definition.	-
cancellationDeadline	string	false	The number of hours prior to which an appointment can be canceled.	-
directBookEnabled	boolean	false	Indicates whether patients can find available times for a specific appointment type, provider, or specialty and then directly book an appointment.	-
useLegacyDirectBook	boolean	false	Indicates whether legacy direct book workflows are enabled.	-
guidedSchedulingEnabled	boolean	false	Indicates whether patients can use the guided scheduling feature to schedule a new appointment type, select an appointment type they previously scheduled, or choose from a list of commonly scheduled appointment types.	-
requestSchedulingViaQueueEnabled	boolean	false	Indicates whether patients can send a secure message to request an appointment that is then scheduled based on a queue system.	-
directBookAppointmentDelay	string	false	The number of hours configured for a direct book appointment delay.	-
requestRescheduleEnabled	boolean	false	Indicates whether users can request to reschedule an appointment.	-
geoLocationEnabled	boolean	false	Indicates whether a patient can view information about a location, such as a patient-friendly name or the location phone number and address.	-
videoVisitVendor	string	false	The video visit vendor. The value can be `VYOPTA` or `AMWELL`.	-
requestCancelViaMessageEnabled	boolean	false	Indicates whether users can send a message to request cancellation.	-
appointmentBookingThreshold	string	false	The number of appointments that can be booked per day.	-
requestSchedulingViaMessageEnabled	boolean	false	Indicates whether users send use a message to request rescheduling.	-
directCancelEnabled	boolean	false	Indicates whether direct cancellation is enabled.	-
directRescheduleEnabled	boolean	false	Indicates whether patients can directly reschedule an appointment.	-
npaAuthUsersEnabled	boolean	false	Indicates whether new patients can send a message to request rescheduling in an authenticated user workflow.	-
npaUnauthUsersEnabled	boolean	false	Indicates whether new patients can send a message to request rescheduling in an unauthenticated user workflow.	-
npaPortalAccountEnabled	boolean	false	Indicates whether consumers can create a Cerner Health account or patient portal account before they schedule an appointment. This feature can be enabled or disabled by tenants.	-
npaSsnEnabled	boolean	false	Indicates whether a Social Security number (SSN) is enabled on the patient details page for new patient appointments.	-
directBookContactViaPhoneEnabled	boolean	false	Indicates whether portal users can call a phone contact to directly book an appointment.	-
directBookContactViaMessageEnabled	boolean	false	Indicates whether portal users can send a secure message to directly book an appointment.	-
npaPortalAccountMinAge	string	false	The minimum age value for Cerner Health accounts or patient portal accounts.	-
npaSsnAliasPoolCode	string	false	The Social Security number (SSN) alias pool code that is used to store patient SSNs.	-
facilityOrganizationId	string	false	The unique ID of the facility where patient registration is performed for new patient appointments.	-
npaRequestSchedulingEnabled	boolean	false	Indicates whether the request scheduling workflow is enabled or disabled for new patient appointments.	-
clipboardsEnabled	boolean	false	Indicates whether the request clipboards workflow is enabled or disabled.	-
domain	string	false	The base legacy portal URL for building legacy redirects.	-
videoVisitsEnabled	boolean	false	Indicates whether video visits are enabled for a client.	-
amwellAppId	string	false	The App Id for launching an Amwell Scheduled Video Visit. Only needed when a client is using Amwell as the vendor and they need a different App Id than the default.	-
legacyRequestWorkflowsEnabled	boolean	false	Indicates whether legacy request scheduling workflows are enabled for a client.	-
bookByProviderEnabled	boolean	false	Indicates whether book by provider scheduling workflows are enabled for a client.	-

postSchedulingFeatureConfigurations

Name	Type	Required	Description	Accepted Values
featureDefinitionId	string	true	The ID of the feature definition.	-
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application.	-

putSchedulingFeatureConfigurations

Name	Type	Required	Description	Accepted Values
featureDefinitionId	string	true	The ID of the feature definition.	-
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application.	-

GetProviderConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_GetProviderConfiguration

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the provider configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	false	The domain for which the provider definition is configured.	-
providerDefinition	PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_ProviderDefinitionEntity	true	The provider definition that is configured.	-
createdAt	string	true	The date and time when the provider configuration was created.	-
updatedAt	string	true	The date and time when the provider configuration was most recently updated.	-

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_ProviderDefinitionEntity

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the provider definition.	-
providerIds	string	true	The list of provider identifiers.	-
providers	PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_ProviderDefinitionReference	true	An array of hashed provider IDs and names that are paired by key value.	-

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_ProviderDefinitionReference

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the provider in Cerner Millennium.	-
name	string	false	The name of the provider. This does not map to the provider name in Cerner Millennium.	-

postSchedulingProviderConfigurations

Name	Type	Required	Description	Accepted Values
providerDefinitionId	string	true	The ID of the provider definition.	-
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application.	-

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PostProviderConfiguration

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the provider configuration associated with the Health Data Intelligence tenant.	-
providerDefinitionId	string	false	The unique ID of the provider definition associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	false	The domain for which the provider definition is configured.	-
createdAt	string	true	The date and time when the provider configuration was created.	-
updatedAt	string	true	The date and time when the provider configuration was most recently updated.	-

putSchedulingProviderConfigurations

Name	Type	Required	Description	Accepted Values
providerDefinitionId	string	true	The ID of the provider definition.	-
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application.	-

ProviderDefinitions

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

PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_ProviderDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the provider definition associated with the Health Data Intelligence tenant.	-
providerIds	string	true	The list of provider identifiers.	-
providers	PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_ProviderDefinitionReference	true	An array of hashed provider IDs and names that are paired by key value.	-
createdAt	string	true	The date and time when the provider definition was created.	-
updatedAt	string	true	The date and time when the provider definition was most recently updated.	-

postSchedulingProviderDefinitions

Name	Type	Required	Description	Accepted Values
providers	[object]	true	An array of hashed provider IDs and names that are paired by key value.	-
» id	string	true	The unique ID of the provider in Cerner Millennium.	-
» name	string	false	The name of the provider. This value does not map to the provider name in Cerner Millennium.	-

GetGuidedConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_GetGuidedConfigurations

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID for the guided scheduling configuration.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
questionnaires	[PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionnaireBody]	true	A set of guided scheduling appointment questions.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionnaireBody

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the guided scheduling questionnaire.	-
name	string	true	The display name of the guided scheduling questionnaire.	-
locale	string	true	The locale of the guided scheduling questionnaire.	-
description	string	true	The description of the guided scheduling questionnaire.	-

postGuidedSchedulingConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
questionnaires	[object]	true	The ID of the questionnaire.	-
» id	string	true	The ID of the questionnaire.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_PostGuidedConfigurations

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID for the guided scheduling configuration.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
questionnaires	[PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionnaireAttribute]	true	The ID of the questionnaire.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionnaireAttribute

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

putGuidedSchedulingConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
questionnaires	[object]	true	The ID of the questionnaire.	-
» id	string	true	The ID of the questionnaire.	-

postSchedulingQuestionnaires

Name	Type	Required	Description	Accepted Values
name	string	true	The unique name of the guided scheduling of the Health Data Intelligence tenant.	-
locale	string	true	The locale of the guided scheduling definitions.	-
description	string	true	The description of the guided scheduling definitions.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_PostQuestionnaires

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the guided scheduling questionnaire.	-
name	string	true	The unique name of the guided scheduling questionnaire of the Health Data Intelligence tenant.	-
locale	string	true	The locale of the guided scheduling questionnaire.	-
description	string	true	The description of the guided scheduling questionnaire.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

GetQuestionnaires

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

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_GetQuestionnaires

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the guided scheduling questionnaire.	-
name	string	true	The unique name of the guided scheduling questionnaire of the Health Data Intelligence tenant.	-
locale	string	true	The locale of the guided scheduling questionnaire.	-
description	string	true	The description of the guided scheduling questionnaire.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_GetQuestionnairesId

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the guided scheduling questionnaire.	-
locale	string	true	The locale of the guided scheduling questionnaire.	-
name	string	true	The unique name of the guided scheduling questionnaire of the Health Data Intelligence tenant.	-
description	string	true	The description of the guided scheduling questionnaire.	-
questions	[PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_Questions]	true	The list of questions.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_Questions

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the question.	-
text	string	true	The text of the question.	-
options	[PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_Options]	true	The answers to the question.	-
rules	[PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionsRule]	true	Indicates when to enable a question.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_Options

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the question option.	-
text	string	true	The display name of the question option.	-
appointmentType	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_AppointmentType	true	The appointment type information.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_AppointmentType

Name	Type	Required	Description	Accepted Values
appointmentSynonymCode	string	true	The unique appointment synonym Code of the Cerner Millennium appointment type.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionsRule

Name	Type	Required	Description	Accepted Values
question	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionAttribute	true	The unique ID of the instance question.	-
option	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_OptionAttribute	true	The unique ID of the answer.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionAttribute

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

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_OptionAttribute

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

putSchedulingQuestionnaires

Name	Type	Required	Description	Accepted Values
name	string	true	The unique name of the guided scheduling of the Health Data Intelligence tenant.	-
locale	string	true	The locale of the guided scheduling definitions.	-
description	string	true	The description of the guided scheduling definitions.	-

postSchedulingQuestionnairesQuestionnaireidQuestions

Name	Type	Required	Description	Accepted Values
questions	[object]	true	The set of questions and options.	-
» text	string	true	The description of the question.	-
» options	[object]	true	The set of options.	-
»» text	string	true	The description of the option.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_PostQuestionnairesQuestions

Name	Type	Required	Description	Accepted Values
questions	[PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionsOutput]	true	The list of questions.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionsOutput

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the question.	-
text	string	true	The description of the question.	-
options	[PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionOptions]	true	The appointment type information.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionOptions

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the option.	-
text	string	true	The display value of the option.	-

GetQuestionnairesQuestions

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

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_GetQuestionnairesQuestions

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the question.	-
text	string	true	The description of the question.	-
options	[PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionOptions]	true	The appointment type information.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

putSchedulingQuestionnairesQuestionnaireidQuestions

Name	Type	Required	Description	Accepted Values
text	string	true	The description of the option.	-
options	[object]	false	The hash of the option text and option ID.	-
» id	string	true	The ID of the option.	-
» text	string	true	The description of the option.	-

postSchedulingQuestionnairesQuestionnaireidRules

Name	Type	Required	Description	Accepted Values
rules	[object]	true	The set of questions and options.	-
» question	object	true	The unique ID of the question.	-
»» id	string	true	The unique ID of the question.	-
» option	object	true	The unique ID of the answer.	-
»» id	string	true	The unique ID of the option.	-
» linkedQuestion	object	true	The unique ID of a question with reference to available options based on predefined guided scheduling rules.	-
»» id	string	false	The unique ID of the question.	-
» appointmentType	object	true	The hash of the appointment type.	-
»» appointmentSynonymCode	string	false	The unique ID of Cerner Millennium appointment type.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_PostQuestionnaireRules

Name	Type	Required	Description	Accepted Values
rules	[PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_RulesPost]	true	The list of guided rules.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_RulesPost

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the instance rule.	-
question	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionAttribute	true	The unique ID of the instance question.	-
option	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_OptionAttribute	true	The unique ID of the answer.	-
linkedQuestion	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_LinkedQuestionAttribute	true	The unique ID of the linked question.	-
appointmentType	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_AppointmentType	true	The appointment type information.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_LinkedQuestionAttribute

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

GetQuestionnaireRules

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

PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_GetQuestionnaireRules

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the instance rule.	-
question	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_QuestionAttribute	true	The unique ID of the instance question.	-
option	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_OptionAttribute	true	The unique ID of the answer.	-
linkedQuestion	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_LinkedQuestionAttribute	true	The unique ID of the linked question.	-
appointmentType	PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_AppointmentType	true	The appointment type information.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

putSchedulingQuestionnairesQuestionnaireidRules

Name	Type	Required	Description	Accepted Values
question	object	true	The unique ID of the question.	-
» id	string	true	The unique ID of the question.	-
option	object	true	The unique ID of the answer.	-
» id	string	true	The unique ID of the option.	-
linkedQuestion	object	true	The unique ID of a question with reference to available options based on predefined guided scheduling rules.	-
» id	string	false	The unique ID of the question.	-
appointmentType	object	true	The hash of the appointment type.	-
» appointmentSynonymCode	string	false	The unique ID of Cerner Millennium appointment type.	-

AppointmentLocationsEntities

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

PatientPortalApplicationPublicApi_Entities_V1_SchedulingGeoLocation_AppointmentLocationsEntity

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the appointment locations associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application that uses the geolocation service.	-
locationId	string	true	The unique ID of the location associated with the Health Data Intelligence tenant.	-
name	string	true	The name of the location.	-
phone	string	false	The phone number of the location.	-
phoneExt	string	false	The phone extension of the location.	-
street1	string	true	The street of the location.	-
street2	string	false	The street of the location.	-
street3	string	false	The street of the location.	-
street4	string	false	The street of the location.	-
city	string	true	The city in which the location is present.	-
state	string	true	The state in which the location is present.	-
postalCode	string	true	The postal code of the location.	-
country	string	false	The country in which the location is present.	-
latitude	number(float)	true	The latitude of the location.	-
longitude	number(float)	true	The longitude of the location.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was most recently updated.	-

postAppointmentLocationsSearch

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application that uses the geolocation service.	-
locationIds	[string]	true	The list of location IDs to match the appointment locations	-
sourceLocation	string	false	The source location needed to calculate the nearest appointment locations.	-
milesLimit	string	false	The maximum number of miles away from the patient’s address that the appointment locations should be.	-

postSchedulingLoadAppointmentLocations

Name	Type	Required	Description	Accepted Values
appointmentLocations	[object]	true	The appointment locations.	-
» applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application that uses the geolocation service.	-
» locationId	string	true	The unique ID of the location associated with the Health Data Intelligence tenant.	-
» name	string	true	The name of the location.	-
» phone	string	false	The phone number of the location.	-
» phoneExt	string	false	The phone extension of the location.	-
» street1	string	true	The street of the location.	-
» street2	string	false	The street of the location.	-
» street3	string	false	The street of the location.	-
» street4	string	false	The street of the location.	-
» city	string	true	The city in which the location is present.	-
» state	string	true	The state in which the location is present.	-
» postalCode	string	true	The postal code of the location.	-
» country	string	false	The country in which the location is present.	-

PatientPortalApplicationPublicApi_Entities_V1_SchedulingGeoLocation_AppointmentLocationJob

Name	Type	Required	Description	Accepted Values
jobId	integer(int64)	true	Unique Job Identification Number	-

PatientPortalApplicationPublicApi_Entities_V1_SchedulingGeoLocation_JobTracker

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The domain name of a tenant in the patient portal application that uses the geolocation service.	-
jobStatus	string	true	Status of the Delayed job.	-
lastModified	string	true	The date and time when the resource was most recently updated.	-

ReportDefinitions

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

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_ReportDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID associated with the report.	-
report	string	true	The type of report. The portal supports the following report types: CARDIOLOGY, MICROBIOLOGY, PATHOLOGY, and RADIOLOGY.	-
displayStartDate	string	false	The date on which the reports begin to be displayed in the portal. All reports created on or after the start date are displayed in the portal	-
displayUnauthenticated	boolean	false	Indicates whether reports in a status of Unauthenticated are displayed in the portal.	-
displayTranscribed	boolean	false	Indicates whether reports in a status of Transcribed are displayed in the portal.	-
displayInProgress	boolean	false	Indicates whether reports in a status of In-Progress are displayed in the portal.	-
isReportsEnabled	boolean	false	Indicates whether reports are enabled or disabled in the portal.	-
categories	[PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_ReportCategories]	true	An array of event categories and publication delay hours.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_ReportCategories

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the event set or category associated with the event code of the report that is displayed in the portal.	-
publishDelayHours	integer(int32)	false	The publishing time delay, in hours. The report is not available to the patient until it has been available to the clinician for the specified number of hours.	-

postReportsReportDefinitions

Name	Type	Required	Description	Accepted Values
report	string	true	The type of report. The portal supports the following report types: CARDIOLOGY, MICROBIOLOGY, PATHOLOGY, and RADIOLOGY.	CARDIOLOGY, MICROBIOLOGY, PATHOLOGY, RADIOLOGY
displayStartDate	string	false	The date on which the reports begin to be displayed in the portal. All reports created on or after the start date are displayed in the portal.	-
displayUnauthenticated	boolean	false	Indicates whether reports in a status of Unauthenticated are displayed in the portal.	-
displayTranscribed	boolean	false	Indicates whether reports in a status of Transcribed are displayed in the portal.	-
displayInProgress	boolean	false	Indicates whether reports in a status of In-Progress are displayed in the portal.	-
isReportsEnabled	boolean	false	Indicates whether reports are enabled or disabled in the portal.	-
categories	[object]	true	The list of definitions.	-
» name	string	true	The name of the event set or category associated with the event code of the report that is displayed in the portal.	-
» publishDelayHours	integer(int32)	false	The publishing time delay, in hours. The report is not available to the patient until it has been available to the clinician for the specified number of hours.	-

postReportsDataSourceConfigurations

Name	Type	Required	Description	Accepted Values
dataSource	string	true	The data source is an enumerated value. The following values are supported: `HEALTHEINTENT` and `MILLENNIUM`.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_DataSourceConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the data source configuration.	-
dataSource	string	true	The data source is an enumerated value. The following values are supported: `MILLENNIUM` and `HEALTHEINTENT`.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

putReportsDataSourceConfigurations

Name	Type	Required	Description	Accepted Values
dataSource	string	true	The data source is an enumerated value. The following values are supported: `HEALTHEINTENT` and `MILLENNIUM`.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

GetReportConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_GetReportConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the report configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
reportDefinitions	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_ReportDefinition	true	A list of report definitions.	-

postReportsReportConfigurations

Name	Type	Required	Description	Accepted Values
reportDefinitions	[string]	true	The list of definitions.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PostReportConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the report configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
reportDefinitions	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_ReportDefinitionId	true	A list of definitions.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_ReportDefinitionId

Name	Type	Required	Description	Accepted Values
reportDefinitionId	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-

putReportsReportConfigurations

Name	Type	Required	Description	Accepted Values
reportDefinitions	[string]	true	The list of definitions.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

ReportAllConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_ReportAllConfiguration

Name	Type	Required	Description	Accepted Values
policyTextConfiguration	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_GetPolicyTextConfiguration	true	Retrieves the policy text configuration.	-
reportConfiguration	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_GetReportConfiguration	true	Retrieves the report configuration.	-
adolescentDataFlagConfigurations	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_AdolescentDataFlagConfig	true	Retrieves the adolescent data flag configurations.	-
dataSourceConfiguration	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_DataSourceConfiguration	false	The data source configuration associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_GetPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyTextDefinition	PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PolicyTextsReference	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PolicyTextsReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_LocaleTextsEntity]	true	An array of locales and texts.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_LocaleTextsEntity

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_AdolescentDataFlagConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the adolescent data flag configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
report	string	true	The type of report. The portal supports the following report types: CARDIOLOGY, MICROBIOLOGY, PATHOLOGY, and RADIOLOGY.	-
enabled	boolean	true	Indicates whether the adolescent data flag is enabled.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

postReportsPolicyTextDefinitions

Name	Type	Required	Description	Accepted Values
localeTexts	[object]	true	The locale of the policy text.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PolicyTextDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_LocaleTextsEntity]	true	An array of locales and texts.	-

postReportsPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextDefinitionId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PostPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyTextDefinitionId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

putReportsPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextDefinitionId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

postReportsAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
report	string	true	The type of report. The portal supports the following report types: CARDIOLOGY, MICROBIOLOGY, PATHOLOGY, and RADIOLOGY.	CARDIOLOGY, MICROBIOLOGY, PATHOLOGY, RADIOLOGY
enabled	boolean	true	Indicates whether adolescent data flag is enabled for the tenant’s environment.	-

putReportsAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
report	string	true	The type of report. The portal supports the following report types: CARDIOLOGY, MICROBIOLOGY, PATHOLOGY, and RADIOLOGY.	CARDIOLOGY, MICROBIOLOGY, PATHOLOGY, RADIOLOGY
enabled	boolean	true	Indicates whether adolescent data flag is enabled for the tenant’s environment.	-

postNotificationPreferencePolicyTextDefinitions

Name	Type	Required	Description	Accepted Values
localeTexts	[object]	true	The locale of the policy text definition.	-
» locale	string	true	The locale of the policy text definition.	-
» text	string	true	The policy text definition for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_PolicyTextDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_LocaleTextsEntity]	true	The locale and text.	-

PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_LocaleTextsEntity

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

postNotificationPreferencePolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
notificationPreferencePolicyTextDefinitionId	string	true	The unique ID for the policy text definition associated with the Health Data Intelligence tenantId.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_PostPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
notificationPreferencePolicyTextDefinitionId	string	true	The unique ID of the policy text definition associated with the Health Data Intelligence tenant.	-

putNotificationPreferencePolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
notificationPreferencePolicyTextDefinitionId	string	true	The unique ID for the policy text definition associated with the Health Data Intelligence tenantId.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_GetPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
notificationPreferencePolicyTextDefinition	PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_PolicyTextsReference	true	The unique ID of the policy text definition associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_PolicyTextsReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text definition.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_LocaleTextsEntity]	true	The locale and text.	-

CommunicationPreferences

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

PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_CommunicationPreference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the communication preference associated with the Health Data Intelligence tenant.	-
organizationId	string	false	The unique ID of the organization.	-
displayModalPromptEnabled	boolean	false	Indicates whether the modal prompt is enabled or disabled.	-
modalityTextMessageEnabled	boolean	false	Indicates whether text message notifications are enabled or disabled.	-
modalityPushNotificationEnabled	boolean	false	Indicates whether mobile push notifications are enabled or disabled.	-
daysSinceLastUpdate	integer(int32)	false	The number of days until the next modal is displayed.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

postNotificationPreferenceDefinitions

Name	Type	Required	Description	Accepted Values
organizationId	string	false	The ID of the organization.	-
displayModalPromptEnabled	boolean	false	Indicates whether the modal prompt is enabled or disabled.	-
modalityTextMessageEnabled	boolean	false	Indicates whether text message notifications are enabled or disabled.	-
modalityPushNotificationEnabled	boolean	false	Indicates whether mobile push notifications are enabled or disabled.	-
daysSinceLastUpdate	integer(int32)	false	The number of days until the next modal is displayed.	-

GetCommunicationPreferenceConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_GetCommunicationPreferenceConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the communication preference configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
notificationPreferenceDefinition	PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_CommunicationPreferencesReference	true	The unique ID of the communication preference associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_CommunicationPreferencesReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text.	-
organizationId	string	false	The unique ID of the organization.	-
displayModalPromptEnabled	boolean	false	Indicates whether the modal prompt is enabled or disabled.	-
modalityTextMessageEnabled	boolean	false	Indicates whether text message notifications are enabled or disabled.	-
modalityPushNotificationEnabled	boolean	false	Indicates whether mobile push notifications are enabled or disabled.	-
daysSinceLastUpdate	integer(int32)	false	The number of days until the next modal is displayed.	-

postNotificationPreferenceConfigurations

Name	Type	Required	Description	Accepted Values
notificationPreferenceDefinitionId	string	true	The unique ID for the communication definition associated with the Health Data Intelligence tenantId.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

PatientPortalApplicationPublicApi_Entities_V1_NotificationPreferencesConfig_PostCommunicationPreferenceConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the communication preference configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
notificationPreferenceDefinitionId	string	true	The unique ID of the communication preference associated with the Health Data Intelligence tenant.	-

putNotificationPreferenceConfigurations

Name	Type	Required	Description	Accepted Values
notificationPreferenceDefinitionId	string	true	The unique ID for the communication definition associated with the Health Data Intelligence tenantId.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

PatientPortalApplicationPublicApi_Entities_V1_AdolescentConfig_AdolescentDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the adolescent age range definition associated with the Health Data Intelligence tenant.	-
minimumAge	integer(int32)	true	Minimum age for adolescent definition.	-
maximumAge	integer(int32)	true	Maximum age for adolescent definition.	-

AdolescentDefinitions

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

postAdolescentAgeRangeDefinitions

Name	Type	Required	Description	Accepted Values
minimumAge	integer(int32)	true	Minimum age for adolescent definition.	-
maximumAge	integer(int32)	true	Maximum age for adolescent definition.	-

putAdolescentAgeRangeConfigurations

Name	Type	Required	Description	Accepted Values
adolescentAgeRangeDefinitionId	string	true	The unique ID of adolescent age range definition associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AdolescentConfig_GetAdolescentConfiguration

Name	Type	Required	Description	Accepted Values
id	integer(int32)	true	The unique ID of the adolescent age range configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain associated with the adolescent configuration.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
adolescentAgeRange	PatientPortalApplicationPublicApi_Entities_V1_AdolescentConfig_AdolescentDefinition	true	A list of adolescent age range definitions.	-

GetAdolescentConfigurations

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

postAdolescentAgeRangeConfigurations

Name	Type	Required	Description	Accepted Values
adolescentAgeRangeDefinitionId	string	true	The unique ID of adolescent age range definition associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_AdolescentConfig_PostAdolescentConfiguration

Name	Type	Required	Description	Accepted Values
id	integer(int32)	true	The unique ID of the adolescent age range configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain associated with the adolescent configuration.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
adolescentAgeRangeDefinitionId	string	true	The unique ID of adolescent age range definition associated with the Health Data Intelligence tenant.	-

putDocumentsConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
documentDefinitionId	string	true	The ID of the documents definition.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_GetDocumentsConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the documents configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
documentDefinition	PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsDefinition	true	The unique ID of the documents definition associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the documents definition associated with the Health Data Intelligence tenant.	-
dataSource	string	true	The types of documents that are supported in the portal. The following values are possible: `MILLENNIUM` and `HEALTHEINTENT`.	-
displayStartDate	string	false	The documents created before this date are not displayed in the portal.	-
displayUnauthenticated	string	false	Indicates whether documents in an unauthenticated status are displayed in the portal. Documents with a status of authenticated, altered, or modified are always displayed.	-
displayTranscribed	string	false	Indicates whether documents with a transcribed status are displayed in the portal. Documents with a status of authenticated, altered, or modified are always displayed.	-
displayInProgress	string	false	Indicates whether documents with an in progress status are displayed in the portal. Documents with a status of authenticated, altered, or modified are always displayed.	-
isDocumentsEnabled	string	false	Indicates whether documents are enabled or disabled in the portal.	-
categories	[PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsCategories]	true	An array of category names and their associated publishing delay hours.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsCategories

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the event set or category associated with the event code of the document that is displayed in the portal.	-
publishDelayHours	integer(int32)	false	The publishing time delay, in hours. The document is not available to the patient until it has been available to the clinician for the specified number of hours. During the delay period, the following message is displayed in the list, where xxxxx is the document name and yyyyy is the date and time when the document is available: xxxxx pending until yyyyy.	-

GetDocumentsConfigurations

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

postDocumentsConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
documentDefinitionId	string	true	The ID of the documents definition.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_PostDocumentsConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the documents configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
documentDefinitionId	string	true	The unique ID of the documents definition associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsPolicyTextDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsLocaleTexts]	true	An array of locales and texts.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsLocaleTexts

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

DocumentsPolicyTextDefinitions

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

postDocumentsPolicyTexts

Name	Type	Required	Description	Accepted Values
localeTexts	[object]	true	The locale of the policy text.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

putDocumentsPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_GetDocumentsPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID for the environment of the tenant.	-
createdAt	string	true	The timestamp for the resource created time.	-
updatedAt	string	true	The timestamp for the resource updated time.	-
policyText	PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsPolicyTextsReference	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsPolicyTextsReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsLocaleTexts]	true	An array of locales and texts.	-

GetDocumentsPolicyTextConfigurations

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

postDocumentsPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the policy text associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_PostDocumentsPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The ID for the environment of the tenant.	-
createdAt	string	true	The timestamp for the resource created time.	-
updatedAt	string	true	The timestamp for the resource updated time.	-
policyTextId	string	true	The unique ID of the policy text definition associated with the Health Data Intelligence tenant.	-

putDocumentsAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
enabled	boolean	true	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsAdolescentDataFlagConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the adolescent data flag configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
enabled	boolean	true	Indicates whether the adolescent data flag is enabled for the environment of the tenant.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

DocumentsAdolescentDataFlagConfigs

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

postDocumentsAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
enabled	boolean	true	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-

DocumentsDefinitions

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

postDocumentsDefinitions

Name	Type	Required	Description	Accepted Values
dataSource	string	true	The types of documents that are supported in the portal. The following values are possible: `MILLENNIUM` and `HEALTHEINTENT`.	MILLENNIUM, HEALTHEINTENT
displayStartDate	string	false	The documents created before this date are not displayed in the portal.	-
displayUnauthenticated	boolean	false	Indicates whether documents with an unauthenticated status are displayed in the portal. Documents with a status of authenticated, altered, or modified are always displayed.	-
displayTranscribed	boolean	false	Indicates whether documents with a transcribed status are displayed in the portal. Documents with a status of authenticated, altered, or modified are always displayed.	-
displayInProgress	boolean	false	Indicates whether documents with an in progress status are displayed in the portal. Documents with a status of authenticated, altered, or modified are always displayed.	-
isDocumentsEnabled	boolean	false	Indicates whether documents are enabled or disabled in the portal.	-
categories	[object]	true	An array of category names and their associated publishing delay hours.	-
» name	string	true	The name of the event set or category associated with the event code of the document that is displayed in the portal.	-
» publishDelayHours	integer(int32)	false	The publishing time delay, in hours. The document is not available to the patient until it has been available to the clinician for the specified number of hours. During the delay period, the following message is displayed in the list, where xxxxx is the document name and yyyyy is the date and time when the document is available: xxxxx pending until yyyyy.	-

DocumentsAllConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsAllConfiguration

Name	Type	Required	Description	Accepted Values
policyTextConfiguration	PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_GetDocumentsPolicyTextConfiguration	true	Retrieves the policy text configuration.	-
documentConfiguration	PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_GetDocumentsConfiguration	true	Retrieves the document configuration.	-
adolescentDataFlagConfiguration	PatientPortalApplicationPublicApi_Entities_V1_DocumentsConfig_DocumentsAdolescentDataFlagConfig	true	Retrieves the adolescent data flag configuration.	-

GetRenewConfirmationMessageConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetRenewConfirmationMessageConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the renew confirmation message configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
renewConfirmationMessage	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_RenewConfirmationMessageRef	true	The renew confirmation message associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_RenewConfirmationMessageRef

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the renew confirmation message.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MessageLocaleTextsEntity]	true	The locale and text.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MessageLocaleTextsEntity

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the success message.	-
text	string	false	The success message in the locale for the tenant.	-

postMedicationsRenewConfirmationMessageConfigurations

Name	Type	Required	Description	Accepted Values
renewConfirmationMessageId	string	true	The unique ID of the renew confirmation message associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_PostRenewConfirmationMessageConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the renew confirmation message configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
renewConfirmationMessageId	string	true	The unique ID of the renew confirmation message associated with the Health Data Intelligence tenant.	-

putMedicationsRenewConfirmationMessageConfigurations

Name	Type	Required	Description	Accepted Values
renewConfirmationMessageId	string	true	The unique ID of the renew confirmation message associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

RenewConfirmationMessages

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_RenewConfirmationMessage

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the renew confirmation message associated with the Health Data Intelligence tenant.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MessageLocaleTextsEntity]	true	The locale and text.	-

postMedicationsRenewConfirmationMessages

Name	Type	Required	Description	Accepted Values
localeTexts	[object]	true	The locales of the renew confirmation message.	-
» locale	string	true	The locale of the renew confirmation message.	-
» text	string	true	The renew confirmation message for the tenant.	-

MillPolicyTexts

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillPolicyText

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the Cerner Millennium policy text associated with the Health Data Intelligence tenant.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillLocaleTextsEntity]	true	The locale and text.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillLocaleTextsEntity

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the Cerner Millennium policy text.	-
text	string	false	The Cerner Millennium policy text in the locale for the tenant.	-

postMedicationsMillenniumPolicyTexts

Name	Type	Required	Description	Accepted Values
localeTexts	[object]	true	The locale of the Cerner Millennium policy text.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

GetMillPolicyTextConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetMillPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the Cerner Millennium policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyText	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillPolicyTextsReference	true	The unique ID of the Cerner Millennium policy text associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillPolicyTextsReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the Cerner Millennium policy text.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillLocaleTextsEntity]	true	The locale and text.	-

postMedicationsMillenniumPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the Cerner Millennium policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_PostMillPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the Cerner Millennium policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyTextId	string	true	The unique ID of the Cerner Millennium policy text associated with the Health Data Intelligence tenant.	-

putMedicationsMillenniumPolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the Cerner Millennium policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

MillMedDefinitions

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillMedDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID associated with the Cerner Millennium medication definition.	-
enableMedRefills	boolean	false	Indicates whether medication refills are enabled.	-
enableUnlistedRenewals	boolean	false	Indicates whether unlisted renewals are enabled.	-
enableMultRenewals	boolean	false	Indicates whether multiple renewals are enabled.	-
enableMedRenewals	boolean	false	Indicates whether medication renewals are enabled.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

postMedicationsMillenniumMedicationDefinitions

Name	Type	Required	Description	Accepted Values
enableMedRefills	boolean	false	Indicates whether medication refills are enabled or disabled.	-
enableUnlistedRenewals	boolean	false	Indicates whether unlisted renewals are enabled or disabled.	-
enableMultRenewals	boolean	false	Indicates whether multiple renewals are enabled or disabled.	-
enableMedRenewals	boolean	false	Indicates whether medication renewals are enabled or disabled.	-

GetMillMedConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetMillMedConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the Cerner Millennium medication configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
millMedicationDefinition	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MillMedDefinition	true	The Cerner Millennium medication definition associated with the Health Data Intelligence tenant.	-

postMedicationsMillenniumMedicationConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
medicationDefinitionId	string	true	The ID of the Cerner Millennium medication definition.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_PostMillMedConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the Cerner Millennium medication configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
medicationDefinitionId	string	true	The unique ID of the Cerner Millennium medication definition associated with the Health Data Intelligence tenant.	-

putMedicationsMillenniumMedicationConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
medicationDefinitionId	string	true	The ID of the Cerner Millennium medication definition.	-

postMedicationsKnowledgeBases

Name	Type	Required	Description	Accepted Values
localeCodes	[object]	true	The locale of the knowledge base.	-
» locale	string	true	The locale of the knowledge base.	-
» code	string	true	The locale code for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_KnowledgeBase

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant.	-
facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
localeCodes	[PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_LocaleCodesEntity]	true	The locale and code.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_LocaleCodesEntity

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the knowledge base.	-
code	string	false	The locale code of the knowledge base for the tenant.	-

postMedicationsKnowledgeBaseConfigurations

Name	Type	Required	Description	Accepted Values
knowledgeBaseId	string	true	The unique ID for the knowledge base associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_PostKnowledgeBaseConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
knowledgeBaseId	string	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant.	-

putMedicationsKnowledgeBaseConfigurations

Name	Type	Required	Description	Accepted Values
knowledgeBaseId	string	true	The unique ID for the knowledge base associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetKnowledgeBaseConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
knowledgeBase	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_KnowledgeBasesReference	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_KnowledgeBasesReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base.	-
facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
localeCodes	[PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_LocaleCodesEntity]	true	The locale and code.	-

DataSourceConfigs

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_DataSourceConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the data source configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
dataSources	[PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_DataSourcesEntity]	true	The array of data source IDs and their associated type.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_DataSourcesEntity

Name	Type	Required	Description	Accepted Values
type	string	true	The type of data source. The following values are possible: `MILLENNIUM` or `VISTA`.	-
dataSourceIds	[string]	false	The list of data source IDs associated with the specified type.	-

postMedicationsDataSourceConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
dataSources	[object]	true	The array of data source IDs and their associated type.	-
» type	string	true	The type of data source. The following values are possible: `MILLENNIUM` or `VISTA`.	-
» dataSourceIds	[string]	true	The list of data source IDs associated with the specified type.	-

putMedicationsDataSourceConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
dataSources	[object]	true	The array of data source IDs and their associated type.	-
» type	string	true	The type of data source. The following values are possible: `MILLENNIUM` or `VISTA`.	-
» dataSourceIds	[string]	true	The list of data source IDs associated with the specified type.	-

MedAllConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_MedAllConfigurations

Name	Type	Required	Description	Accepted Values
millPolicyTextConfiguration	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetMillPolicyTextConfiguration	false	The Cerner Millennium policy text configuration associated with the Health Data Intelligence tenant.	-
compPolicyTextConfiguration	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetCompPolicyTextConfiguration	false	The comprehensive policy text configuration associated with the Health Data Intelligence tenant.	-
millMedConfiguration	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetMillMedConfiguration	false	The Cerner Millennium medication configuration associated with the Health Data Intelligence tenant.	-
compMedConfiguration	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetCompMedConfiguration	false	The comprehensive medication configuration associated with the Health Data Intelligence tenant.	-
knowledgeBaseConfiguration	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetKnowledgeBaseConfiguration	false	The knowledge base configuration associated with the Health Data Intelligence tenant.	-
adolescentDataFlagConfiguration	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_AdolescentDataFlagConfig	false	The adolescent data flag configuration associated with the Health Data Intelligence tenant.	-
dataSourceConfiguration	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_DataSourceConfig	false	The data source configuration associated with the Health Data Intelligence tenant.	-
renewConfirmationMessageConfiguration	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetRenewConfirmationMessageConfiguration	false	The renew confirmation message configuration associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetCompPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the comprehensive policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyText	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompPolicyTextsReference	true	The unique ID of the comprehensive policy text associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompPolicyTextsReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the comprehensive policy text.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompLocaleTextsEntity]	true	The locale and text.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompLocaleTextsEntity

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the comprehensive policy text.	-
text	string	false	The comprehensive policy text in the locale for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_GetCompMedConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the comprehensive medication configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
compMedicationDefinition	PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompMedDefinition	true	The comprehensive medication definition associated with the Health Data Intelligence tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompMedDefinition

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID associated with the comprehensive medication definition.	-
enableMedRefills	boolean	false	Indicates whether medication refills are enabled.	-
enableUnlistedRenewals	boolean	false	Indicates whether unlisted renewals are enabled.	-
enableMultRenewals	boolean	false	Indicates whether multiple renewals are enabled.	-
educationContentUrl	string	false	The base URL of the page that provides more information.	-
enableMedRenewals	boolean	false	Indicates whether medication renewals are enabled.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_AdolescentDataFlagConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the adolescent data flag configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
enabled	boolean	true	Indicates whether the adolescent data flag is enabled.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

CompPolicyTexts

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompPolicyText

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the comprehensive policy text associated with the Health Data Intelligence tenant.	-
localeTexts	[PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_CompLocaleTextsEntity]	true	The locale and text.	-

postMedicationsComprehensivePolicyTexts

Name	Type	Required	Description	Accepted Values
localeTexts	[object]	true	The locale of the comprehensive policy text.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

GetCompPolicyTextConfigurations

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

postMedicationsComprehensivePolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the comprehensive policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_PostCompPolicyTextConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the comprehensive policy text configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the tenant ID belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
policyTextId	string	true	The unique ID of the comprehensive policy text associated with the Health Data Intelligence tenant.	-

putMedicationsComprehensivePolicyTextConfigurations

Name	Type	Required	Description	Accepted Values
policyTextId	string	true	The unique ID of the comprehensive policy text associated with the Health Data Intelligence tenant ID.	-
applicationExperienceDomain	string	true	The ID of the environment of the tenant.	-

CompMedDefinitions

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

postMedicationsComprehensiveMedicationDefinitions

Name	Type	Required	Description	Accepted Values
enableMedRefills	boolean	false	Indicates whether medication refills are enabled or disabled.	-
enableUnlistedRenewals	boolean	false	Indicates whether unlisted renewals are enabled or disabled.	-
enableMultRenewals	boolean	false	Indicates whether multiple renewals are enabled or disabled.	-
educationContentUrl	string	false	The base URL of the page that provides more information.	-
enableMedRenewals	boolean	false	Indicates whether medication renewals are enabled or disabled.	-

GetCompMedConfigurations

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

postMedicationsComprehensiveMedicationConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
medicationDefinitionId	string	true	The ID of the comprehensive medication definition.	-

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_PostCompMedConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the comprehensive medication configuration.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-
medicationDefinitionId	string	true	The unique ID of the comprehensive medication definition associated with the Health Data Intelligence tenant.	-

putMedicationsComprehensiveMedicationConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
medicationDefinitionId	string	true	The ID of the comprehensive medication definition.	-

postMedicationsAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
enabled	boolean	true	Indicates whether adolescent data flag is enabled for the tenant’s environment.	-

putMedicationsAdolescentDataFlagConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
enabled	boolean	true	Indicates whether adolescent data flag is enabled for the tenant’s environment.	-

RuleGroups

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_RuleGroup

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID associated with the rule group.	-
name	string	false	The name of the rule group.	-
createdAt	string	true	The date and time when the resource was created, in International Organizationfor Standardization (ISO) 8601 extended format with precision YYYY-MM-DDThh:mm:ss.SSSZ	-
updatedAt	string	true	The date and time when the resource was updated, in International Organizationfor Standardization (ISO) 8601 extended format with precision YYYY-MM-DDThh:mm:ss.SSSZ	-

postMedicationRuleGroups

Name	Type	Required	Description	Accepted Values
name	string	false	The name for the rule group.	-

Rules

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_Rules

Name	Type	Required	Description	Accepted Values
locationId	string	true	The ID of the location where the renewal request is sent.	-
poolId	string	true	The ID of the pool associated with the location.	-
displayName	string	true	The user-defined rule name that is displayed in the Medications page.	-
isDefaultPool	boolean	false	The attribute to indicate if the rule is default or not.	-
poolName	string	false	Name associated with the provider’s pool.	-

postMedicationRuleGroupsRulegroupidMedicationRules

Name	Type	Required	Description	Accepted Values
rules	[object]	true	The list of rule definitions defining the association between locationId and poolId	-
» locationId	string	false	The ID of the location where the renewal request is sent. Required attribute for non default rules.	-
» poolId	string	true	The ID of the pool associated with the location.	-
» displayName	string	true	The user-defined rule name that is displayed in the Medications page.	-
» isDefaultPool	boolean	false	The user-defined rule name that is displayed in the Medications page.	-
» poolName	string	false	Name associated with the provider’s pool.	-

RuleConfigurations

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

PatientPortalApplicationPublicApi_Entities_V1_MedicationsConfig_RuleConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the rule configuration.	-
applicationExperienceDomain	string	true	The domain to which the rule configuration belongs.	-
ruleGroupId	string	true	The unique ID of the rule group associated with the Health Data Intelligence `tenantId`.	-
createdAt	string	true	The date and time when the resource was created, in International Organizationfor Standardization (ISO) 8601 extended format with precision YYYY-MM-DDThh:mm:ss.SSSZ	-
updatedAt	string	true	The date and time when the resource was updated, in International Organizationfor Standardization (ISO) 8601 extended format with precision YYYY-MM-DDThh:mm:ss.SSSZ	-

postMedicationRuleConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The domain name of the patient portal site for which rule configuration is created.	-
ruleGroupId	string	true	The unique ID for the rule group associated with the Health Data Intelligence `tenantId`.	-

putMedicationRuleConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The domain name of the patient portal site for which rule configuration is created.	-
ruleGroupId	string	true	The unique ID for the rule group associated with the Health Data Intelligence `tenantId`.	-

putCovidCenterSiteConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain for the COVID Center site configuration	-
active	boolean	false	The COVID Center site feature configuration is active or not	-
immunizations	boolean	false	The immunizations in COVID Center site configuration is active or not	-
discreteResults	boolean	false	The discrete results in COVID Center site configuration is active or not	-
referenceRange	boolean	false	The reference range in COVID Center site configuration is active or not	-
documents	boolean	false	The documents in COVID Center site configuration is active or not	-
vaccineVerification	boolean	false	The vaccine verification in COVID Center site configuration is active or not	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the site.	-

postCovidCenterSiteConfigs

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain for the COVID Center site configuration	-
active	boolean	false	The COVID Center site feature configuration is active or not	-
immunizations	boolean	false	The immunizations in COVID Center site configuration is active or not	-
discreteResults	boolean	false	The discrete results in COVID Center site configuration is active or not	-
referenceRange	boolean	false	The reference range in COVID Center site configuration is active or not	-
documents	boolean	false	The documents in COVID Center site configuration is active or not	-
vaccineVerification	boolean	false	The vaccine verification in COVID Center site configuration is active or not	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the site.	-

PatientPortalApplicationPublicApi_Entities_V1_CovidCenter_SiteConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the COVID center site	-
domain	string	true	The domain associated with the COVID center site	-
active	boolean	false	This flag determines if the COVID center site is active	-
immunizations	boolean	false	This flag determines if the immunization section of COVID center site is active	-
discreteResults	boolean	false	This flag determines if the discrete results section of COVID center site is active	-
referenceRange	boolean	false	This flag determines if the reference range of COVID center site is active	-
documents	boolean	false	This flag determines if the documents section of COVID center site is active	-
vaccineVerification	boolean	false	This flag determines if the vaccine verification section of COVID center site is active	-
notifications	boolean	false	This flag determines if the notifications of COVID center site configuration is active.This value is not store but evaluated during runtime based on other flags.	-
policyTexts	[PatientPortalApplicationPublicApi_Entities_V1_CovidCenter_LocalizedPolicyText]	false	An array of locales and policy texts.	-

PatientPortalApplicationPublicApi_Entities_V1_CovidCenter_LocalizedPolicyText

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

SiteConfigs

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

putProceduresConfigurations

Name	Type	Required	Description	Accepted Values
dataSource	string	false	The source of data for procedures that are supported in the portal. The following values are possible: `MILLENNIUM` and `HEALTHEINTENT`.	MILLENNIUM, HEALTHEINTENT
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ProceduresConfig_ProceduresConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the procedures configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
dataSource	string	false	The source of data for procedures that are supported in the portal. The following values are possible: `MILLENNIUM` and `HEALTHEINTENT`.	-
adolescentDataEnabled	string	false	Indicates whether users can view adolescent data in the application for the tenant’s environment.	-
policyTexts	[PatientPortalApplicationPublicApi_Entities_V1_ProceduresConfig_LocaleTexts]	false	An array of locales and texts.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_ProceduresConfig_LocaleTexts

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

ProceduresConfigurations

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

postProceduresConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
dataSource	string	false	The source of data for procedures that are supported in the portal. The following values are possible: `MILLENNIUM` and `HEALTHEINTENT`.	MILLENNIUM, HEALTHEINTENT
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

postMessagingPolicies

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale for the messaging policy.	-
policyType	string	true	The type of the messaging policy.	INBOX, SENT, TRASH, SUCCESS, GENERAL
domain	string	true	The domain with which the messaging policy is associated.	-
shortPolicyText	string	true	The short version of the text for the messaging policy.	-
longPolicyText	string	false	The long version of the text for the messaging policy.	-

PatientPortalApplicationPublicApi_Entities_V1_MessagingPolicy

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the messaging policy.	-
locale	string	true	The locale with which this messaging policy is associated. The locale should match the ISO 639-1 specification. See ISO 639 Language Codes on the ISO website for more information.	-
policyType	string	true	The type of the policy.	-
domain	string	true	The domain with which this messaging policy is associated.	-
shortPolicyText	string	true	The short version of the text for the messaging policy.	-
longPolicyText	string	true	The long version of the text for the messaging policy.	-
createdAt	string	true	The date and time when the messaging policy was created.	-
updatedAt	string	true	The date and time when the messaging policy was last updated.	-

MessagingPolicies

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

putMessagingPolicies

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale for the messaging policy.	-
policyType	string	true	The type of the messaging policy.	INBOX, SENT, TRASH, SUCCESS, GENERAL
domain	string	true	The domain with which the messaging policy is associated.	-
shortPolicyText	string	true	The short version of the text for the messaging policy.	-
longPolicyText	string	false	The long version of the text for the messaging policy.	-

putSummariesConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	false	The ID of the tenant’s environment.	-
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
policyTexts	[object]	false	The policy texts and its associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-
reportTemplateId	string	false	The template ID for the CCD health summaries.	-
startDate	string	false	The date when the data for the Health Summaries is available. Data before the configured date is not available for the end user.	-
enableSeamlessSync	boolean	false	The identifier indicates if seamless exchange sync is enabled for the site. Default value is false.	-
numberOfRetries	string	false	Indicates the number of times the seamless exchange sync will be retried in case of failure. Default value is 0 and maximum value is 5.	-
allowSyncAfter	string	false	Indicates the number of hours after which the sync can be triggered again. Default value is 0.	-

PatientPortalApplicationPublicApi_Entities_V1_SummariesConfig_SummariesConfiguration

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the summaries configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled in the application for the tenant’s environment.	-
policyTexts	[PatientPortalApplicationPublicApi_Entities_V1_SummariesConfig_LocaleTexts]	false	An array of locales and texts.	-
reportTemplateId	string	true	The template ID for the CCD health summaries	-
startDate	string	false	The date when the data for the Health Summaries is available. Data before the configured date is not available for the end user.	-
enableSeamlessSync	boolean	false	The identifier indicates if seamless exchange sync is enabled for the site. Default value is false.	-
numberOfRetries	integer(int32)	false	Indicates the number of times the seamless exchange sync will be retried in case of failure. Default value is 0 and maximum value is 5.	-
allowSyncAfter	integer(int32)	false	Indicates the number of hours after which the sync can be triggered again. Default value is 0.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_SummariesConfig_LocaleTexts

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

SummariesConfigurations

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

postSummariesConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
policyTexts	[object]	false	The policy texts and its associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-
reportTemplateId	string	true	The template ID for the CCD health summaries	-
startDate	string	false	The date when the data for the Health Summaries is available. Data before the configured date is not available for the end user.	-
enableSeamlessSync	boolean	false	The identifier indicates if seamless exchange sync is enabled for the site. Default value is false.	-
numberOfRetries	string	false	Indicates the number of times the seamless exchange sync will be retried in case of failure. Default value is 0 and maximum value is 5.	-
allowSyncAfter	string	false	Indicates the number of hours after which the sync can be triggered again. Default value is 0.	-

putResultsConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
educationContentUrl	string	false	The base web address of the Learn More link.	-
knowledgeBase	object	false	The knowledge base associated with the Health Data Intelligence tenant.	-
» _destroy	boolean	false	The flag that deletes knowledge base if its value is true.	-
» facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
» primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
» localeCodes	[object]	false	The locale and code.	-
»» locale	string	true	The locale of the knowledge base.	-
»» code	string	true	The locale code of the knowledge base for the tenant.	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-
dataSource	string	false	The source of data for results that are supported in the portal. The following values are possible: MILLENNIUM and HEALTHEINTENT	HEALTHEINTENT, MILLENNIUM
isResultsEnabled	boolean	false	Indicates whether results are enabled or disabled in the portal.	-
results	object	false	The configurations for results.	-
» adolescentDataEnabled	boolean	true	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
» normalcyValuesEnabled	boolean	true	The identifier indicating if Normalcy values are enabled for the portal users to view for the environment of the tenant.	-
» labDelayHours	integer(int32)	true	The duration between a when a result is final and when it is available to the patient, in hours. The lab results are not viewable to the patient until X hours after it is viewable to the clinician.	-
vitals	object	false	The configurations for vitals.	-
» adolescentDataEnabled	boolean	true	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
» normalcyValuesEnabled	boolean	true	The identifier indicating if Normalcy values are enabled for the portal users to view for the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_ResultsConfigurations

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the results configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
educationContentUrl	string	false	The base web address of the Learn More link.	-
dataSource	string	false	The source of data for results that are supported in the portal. The following values are possible: MILLENNIUM and HEALTHEINTENT	-
isResultsEnabled	boolean	false	Indicates whether results are enabled or disabled in the portal.	-
results	PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_Results	false	The configurations for results.	-
vitals	PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_Vitals	false	The configurations for vitals.	-
knowledgeBase	PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_KnowledgeBase	false	The knowledge base associated with the Health Data Intelligence tenant.	-
policyTexts	[PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_LocaleTexts]	false	An array of locales and texts.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_Results

Name	Type	Required	Description	Accepted Values
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
normalcyValuesEnabled	boolean	false	The identifier indicating if Normalcy values are enabled for the portal users to view for the environment of the tenant.	-
labDelayHours	integer(int32)	false	The duration between a when a result is final and when it is available to the patient, in hours. The lab results are not viewable to the patient until X hours after it is viewable to the clinician.	-

PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_Vitals

Name	Type	Required	Description	Accepted Values
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
normalcyValuesEnabled	boolean	false	The identifier indicating if Normalcy values are enabled for the portal users to view for the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_KnowledgeBase

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant	-
facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
localeCodes	[PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_LocaleCodes]	true	The locale and code.	-

PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_LocaleCodes

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the knowledge base.	-
code	string	false	The locale code of the knowledge base for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ResultsConfig_LocaleTexts

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

ResultsConfigurations

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

postResultsConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The domain to which the configuration belongs.	-
educationContentUrl	string	false	The base web address of the Learn More link.	-
dataSource	string	false	The source of data for results that are supported in the portal. The following values are possible: MILLENNIUM and HEALTHEINTENT	HEALTHEINTENT, MILLENNIUM
isResultsEnabled	boolean	false	Indicates whether results are enabled or disabled in the portal.	-
knowledgeBase	object	false	The knowledge base associated with the Health Data Intelligence tenant.	-
» facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
» primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
» localeCodes	[object]	false	The locale and code.	-
»» locale	string	true	The locale of the knowledge base.	-
»» code	string	true	The locale code of the knowledge base for the tenant.	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-
results	object	false	The configurations for results.	-
» adolescentDataEnabled	boolean	true	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
» normalcyValuesEnabled	boolean	true	The identifier indicating if Normalcy values are enabled for the portal users to view for the environment of the tenant.	-
» labDelayHours	integer(int32)	true	The duration between a when a result is final and when it is available to the patient, in hours. The lab results are not viewable to the patient until X hours after it is viewable to the clinician.	-
vitals	object	false	The configurations for vitals.	-
» adolescentDataEnabled	boolean	true	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
» normalcyValuesEnabled	boolean	true	The identifier indicating if Normalcy values are enabled for the portal users to view for the environment of the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_SummariesRequests_SummariesRequest

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the health summaries request associated with the Health Data Intelligence tenant.	-
requesterId	string	false	The unique millennium identifier of the patient who is requesting the information.	-
applicationExperienceDomain	string	true	The domain to which the request belongs.	-
startDate	string	false	The date from which the data for the ccd should be available. Data before the configured date will not be available for the end user.	-
endDate	string	false	The date upto which the ccd should be available.	-
status	string	false	The status of the Health Summary Request.	-
email	string	false	The email address of the user for sending notifications once the document is available.	-
concepts	[PatientPortalApplicationPublicApi_Entities_V1_SummariesRequests_Concepts]	false	An array of summary concept id and names	-
ccdDocuments	[PatientPortalApplicationPublicApi_Entities_V1_SummariesRequests_CcdDocuments]	false	An array of summary concept id and names	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_SummariesRequests_Concepts

Name	Type	Required	Description	Accepted Values
id	string	true	The unique identifier of the concept	-
name	string	true	The name of the concept. The list of concepts: `IMMUNIZATIONS`, `CONDITIONS`, `ALLERGIES`, `MEDICATIONS`, `ENCOUNTERS`, `OBSERVATIONS`, `PROCEDURES` and `DOCUMENTS`.	-

PatientPortalApplicationPublicApi_Entities_V1_SummariesRequests_CcdDocuments

Name	Type	Required	Description	Accepted Values
id	string	true	The unique identifier of the ccdSummary.	-
name	string	true	The name of the generated ccdSummary document.	-
contentType	string	true	The mime type of the generated ccdSummary document.	-
summaryType	string	true	The type of the summary generated. It can be RAW or FILTERED	-

SummariesRequests

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

postPatientSummaries

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment.	-
patientId	string	true	The unique Cerner Millennium identifier for a patient.	-
requesterId	string	false	The unique millennium identifier of the patient who is requesting the information.	-
startDate	string	false	The date from which the data for the Health Summaries should be available. Data before the configured date is not available for the end user.	-
endDate	string	false	The date upto which the ccd should be available.	-
email	string	false	The email address of the user for sending notifications once the document is available.	-
concepts	[string]	false	The concepts selected by the user to generate the ccd.	-

PatientPortalApplicationPublicApi_Entities_V1_SummariesRequests_GetCcdDocuments

Name	Type	Required	Description	Accepted Values
id	string	true	The unique identifier of the ccdSummary.	-
name	string	true	The name of the generated ccdSummary document.	-
contentType	string	true	The mime type of the generated ccdSummary document.	-
summaryType	string	true	The type of the summary generated. It can be RAW or FILTERED	-
data	string	true	The binary file generated by the summaries request.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

postImagingConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
delayHours	integer(int32)	false	Number of hours after the image is available that it can be viewed by the user.	-
featureEnabled	boolean	false	The enable or disable capability that allows users to control visibility of the imaging download study feature.	-
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled in the application for the tenant’s environment.	-
imagingEnabled	boolean	false	Indicates whether the Diagnostic Imaging application is enabled or disabled in the portal.	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_ImagingConfig_ImagingConfigurations

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the imaging configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The identifier for the environment of the tenant.	-
delayHours	integer(int32)	true	Number of hours after the image is available that it can be viewed by the user.	-
featureEnabled	boolean	false	The enable or disable capability that allows users to control visibility of the imaging download study feature.	-
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled in the application for the tenant’s environment.	-
imagingEnabled	boolean	false	Indicates whether the Diagnostic Imaging application is enabled or disabled in the portal.	-
policyTexts	[PatientPortalApplicationPublicApi_Entities_V1_ImagingConfig_LocaleTexts]	false	An array of locales and texts.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_ImagingConfig_LocaleTexts

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

ImagingConfigurations

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

putImagingConfigurations

Name	Type	Required	Description	Accepted Values
delayHours	integer(int32)	true	Number of hours after the image is available that it can be viewed by the user.	-
featureEnabled	boolean	false	The enable or disable capability that allows users to control visibility of the imaging download study feature.	-
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled in the application for the tenant’s environment.	-
imagingEnabled	boolean	false	Indicates whether the Diagnostic Imaging application is enabled or disabled in the portal.	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

postImagingRequests

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the tenant’s environment	-
patientId	string	true	The unique Cerner Millennium ID for a patient	-
requesterId	string	false	The unique Cerner Millennium ID for the patient who is requesting the information.	-
studyId	string	true	The study identifier associated with the image (URN).	-
studyDate	string	true	The date and time of the study.	-
email	string	false	The email address of the user for sending notifications once the study is available.	-
patientName	string	false	The patient name to include in the notification email once the study is available.	-

PatientPortalApplicationPublicApi_Entities_V1_ImagingRequests_ImagingRequest

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the health imaging download request associated with the Health Data Intelligence tenant.	-
patientId	string	true	The unique Cerner Millennium ID for a patient.	-
requesterId	string	true	The unique Cerner Millennium ID for the patient who is requesting the information.	-
studyId	string	true	The study identifier associated with the image (URN).	-
studyDate	string	false	The date and time of the study.	-
s3Key	string	true	The key used to retrieve the .ZIP file from Object Storage (NetApp with Amazon S3)when the user requests it. the download of the study.	-
status	string	true	The status of the health imaging download request.	-
email	string	false	The email address of the user for sending notifications once the study is available.	-
patientName	string	false	The patient name to include in the notification email once the study is available.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

ImagingRequests

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

postMillenniumPatientNotifications

Name	Type	Required	Description	Accepted Values
patientId	string	true	The Cerner Millennium patient identifier of the patient for whom the message is sent by the provider.	-
millenniumOrganization	string	false	The Cerner Mllennium organization identifier to determine for which site the notification is triggered.	-
domain	string	false	The identifier of the Cerner Millennium domain.	-
eventIds	[string]	false	This parameter is an array with identifiers passed from the Cerner Millennium event.	-
eventType	string	true	This parameter represents the type of event.	-
eventTriggeredAt	string(date)	false	This parameter represents the date and time at which the notification was triggered.	-
reminderDate	string(date)	false	The date of the scheduled message to be sent to the patient and related persons.	-

postConditionsConfigurations

Name	Type	Required	Description	Accepted Values
applicationExperienceDomain	string	true	The ID of the environment associated with the tenant.	-
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
educationContentUrl	string	false	The base web address of the Learn More link.	-
dataSource	string	false	The source of data for conditions that are supported in the portal. The following values are possible: MILLENNIUM and HEALTHEINTENT	HEALTHEINTENT, MILLENNIUM
knowledgeBase	object	false	The knowledge base associated with the Health Data Intelligence tenant.	-
» facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
» primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
» localeCodes	[object]	false	The locale and code.	-
»» locale	string	true	The locale of the knowledge base.	-
»» code	string	true	The locale code of the knowledge base for the tenant.	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_HealthConditionsConfig_ConditionsConfigurations

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the conditions configuration associated with the Health Data Intelligence tenant.	-
applicationExperienceDomain	string	true	The identifier for the environment of the tenant.	-
adolescentDataEnabled	boolean	false	The identifier indicating if Adolescent Sensitive Data is enabled for the environment of the tenant.	-
educationContentUrl	string	false	The base web address of the Learn More link.	-
dataSource	string	false	The source of data for conditions that are supported in the portal. The following values are possible: MILLENNIUM and HEALTHEINTENT	-
knowledgeBase	PatientPortalApplicationPublicApi_Entities_V1_HealthConditionsConfig_KnowledgeBase	false	The knowledge base associated with the Health Data Intelligence tenant.	-
policyTexts	[PatientPortalApplicationPublicApi_Entities_V1_HealthConditionsConfig_LocaleTexts]	false	An array of locales and texts.	-
createdAt	string	true	The date and time when the resource was created.	-
updatedAt	string	true	The date and time when the resource was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_HealthConditionsConfig_KnowledgeBase

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the knowledge base associated with the Health Data Intelligence tenant	-
facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
localeCodes	[PatientPortalApplicationPublicApi_Entities_V1_HealthConditionsConfig_LocaleCodes]	true	The locale and code.	-

PatientPortalApplicationPublicApi_Entities_V1_HealthConditionsConfig_LocaleCodes

Name	Type	Required	Description	Accepted Values
locale	string	false	The locale of the knowledge base.	-
code	string	false	The locale code of the knowledge base for the tenant.	-

PatientPortalApplicationPublicApi_Entities_V1_HealthConditionsConfig_LocaleTexts

Name	Type	Required	Description	Accepted Values
locale	string	true	The locale of the policy text.	-
text	string	true	The policy text for the tenant.	-

ConditionsConfigurations

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

putConditionsConfigurations

Name	Type	Required	Description	Accepted Values
adolescentDataEnabled	boolean	false	Indicates whether the adolescent data flag is enabled for the tenant’s environment.	-
educationContentUrl	string	false	The base web address of the Learn More link.	-
dataSource	string	false	The source of data for conditions that are supported in the portal. The following values are possible: MILLENNIUM and HEALTHEINTENT	HEALTHEINTENT, MILLENNIUM
knowledgeBase	object	false	The knowledge base associated with the Health Data Intelligence tenant.	-
» _destroy	boolean	false	The flag that deletes knowledge base if its value is true.	-
» facilityCd	string	true	The code value of the tenant facility that represents the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred.	-
» primaryCriteriaCd	string	true	The code value of the primary search criteria for the knowledge base.	-
» localeCodes	[object]	false	The locale and code.	-
»» locale	string	true	The locale of the knowledge base.	-
»» code	string	true	The locale code of the knowledge base for the tenant.	-
policyTexts	[object]	false	The policy texts and their associated locales.	-
» locale	string	true	The locale of the policy text.	-
» text	string	true	The policy text for the tenant.	-

ClipboardConfigs

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

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ClipboardConfig

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific clipboard application configuration.	-
domain	string	true	The domain of a specific clipboard application configuration.	-
locale	string	true	The locale of a specific clipboard application configuration.	-
enabled	boolean	true	Indicates whether the entire clipboard application is enabled for a given patient portal domain and locale.	-
orgType	string	false	The organization type of a specific clipboard application configuration.	-
nameSingular	string	true	Singular name of the clipboards feature.	-
namePlural	string	true	Plural name of the clipboards feature.	-
availableClipboardsTabName	string	true	Name displayed on the Available clipboards tab.	-
completedClipboardsTabName	string	true	Name displayed on the Completed clipboards tab.	-
assignedClipboardsName	string	true	Name displayed for Assigned clipboards.	-
availableClipboardsName	string	true	Name displayed for Available clipboards.	-
policyText	string	false	Policy text displayed for the clipboards application.	-
displayClipboardDaysPrior	integer(int32)	false	Number of days before an appointment to display a clipboard.	-
createdAt	string	true	The date and time when the clipboard application configuration was created.	-
createdById	string	true	The ID of the user who created the clipboard application configuration.	-
updatedAt	string	true	The date and time when the clipboard application configuration was updated.	-
updatedById	string	true	The ID of the user who last updated the clipboard application configuration.	-
enableSensitiveStandardForms	boolean	true	If enabled, this control will prevent the proxy user from accessing an adolescent’s standard forms.	-

postClipboardConfigurations

Name	Type	Required	Description	Accepted Values
enabled	boolean	false	Indicates whether the entire clipboard application is enabled for a given patient portal domain and locale.	-
domain	string	true	The domain of a specific clipboard application configuration.	-
locale	string	true	The locale of a specific clipboard application configuration.	-
orgType	string	false	The organization type of a specific clipboard application configuration.	-
nameSingular	string	true	Singular name of the clipboards feature.	-
namePlural	string	true	Plural name of the clipboards feature.	-
availableClipboardsTabName	string	true	Name displayed on the Available clipboards tab.	-
completedClipboardsTabName	string	true	Name displayed on the Completed clipboards tab.	-
assignedClipboardsName	string	true	Name displayed for Assigned clipboards.	-
availableClipboardsName	string	true	Name displayed for Available clipboards.	-
policyText	string	false	Policy text displayed for the clipboards application.	-
displayClipboardDaysPrior	integer(int32)	false	Number of days before an appointment to display a clipboard.	-
enableSensitiveStandardForms	boolean	false	If enabled, this control will prevent the proxy user from accessing an adolescent’s standard forms.	-
createdById	string	true	User ID of the user creating this resource	-

putClipboardConfigurations

Name	Type	Required	Description	Accepted Values
enabled	boolean	true	Indicates whether the entire clipboard application is enabled for a given patient portal domain and locale.	-
domain	string	true	The domain of a specific clipboard application configuration.	-
locale	string	true	The locale of a specific clipboard application configuration.	-
orgType	string	false	The organization type of a specific clipboard application configuration.	-
nameSingular	string	true	Singular name of the clipboards feature.	-
namePlural	string	true	Plural name of the clipboards feature.	-
availableClipboardsTabName	string	true	Name displayed on the Available clipboards tab.	-
completedClipboardsTabName	string	true	Name displayed on the Completed clipboards tab.	-
assignedClipboardsName	string	true	Name displayed for Assigned clipboards.	-
availableClipboardsName	string	true	Name displayed for Available clipboards.	-
policyText	string	false	Policy text displayed for the clipboards application.	-
displayClipboardDaysPrior	integer(int32)	false	Number of days before an appointment to display a clipboard.	-
enableSensitiveStandardForms	boolean	false	If enabled, this control will prevent the proxy user from accessing an adolescent’s standard forms.	-
updatedById	string	true	User ID of the user updating this resource	-

ClipboardBasics

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

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ClipboardBasic

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific clipboard configuration.	-
domain	string	true	The domain of a specific clipboard configuration.	-
locale	string	true	The locale of a specific clipboard configuration.	-
version	integer(int32)	true	The version of a specific clipboard configuration.	-
active	boolean	true	Indicates whether the clipboard can be assigned to users. For a given domain and a given clipboard name, only the most recent version has this flag set to True. If a clipboard is deleted, then for all versions of that clipboard, the active flag is set to False.	-
orgType	string	false	The organization type of a specific clipboard application configuration.	-
name	string	true	Name of the clipboard.	-
nameFriendly	string	true	The name of the clipboard as displayed to members.	-
clipboardRetired	boolean	true	Indicates whether the Clipboard is retired. This is the case when the latest version of a Clipboard (specified by name, locale, domain) is set to active=false. If latest version is active=true then clipboardRetired is false.	-
createdAt	string	true	The date and time when the clipboard was created.	-
createdById	string	true	The ID of the user who created the clipboard.	-
updatedAt	string	true	The date and time when the clipboard was updated.	-
updatedById	string	true	The ID of the user who last updated the clipboard.	-

postClipboards

Name	Type	Required	Description	Accepted Values
domain	string	true	The domain of a specific clipboard configuration.	-
locale	string	true	The locale of a specific clipboard configuration.	-
name	string	true	Name of the clipboard.	-
nameFriendly	string	true	The name of the clipboard as displayed to members.	-
policyText	string	false	Policy text for this clipboard.	-
requestRemovalPolicyText	string	false	Policy text for requests for removal of this clipboard.	-
successMessagePolicyText	string	true	Policy text when clipboard is successful.	-
createdById	string	true	User ID of the user creating this resource	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_PostClipboard

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific clipboard configuration.	-
domain	string	true	The domain of a specific clipboard configuration.	-
locale	string	true	The locale of a specific clipboard configuration.	-
version	integer(int32)	true	The version of a specific clipboard configuration.	-
active	boolean	true	Indicates whether the clipboard can be assigned to users. For a given domain and a given clipboard name, only the most recent version has this flag set to True. If a clipboard is deleted, then for all versions of that clipboard, the active flag is set to False.	-
orgType	string	false	The organization type of a specific clipboard application configuration.	-
name	string	true	Name of the clipboard.	-
nameFriendly	string	true	The name of the clipboard as displayed to members.	-
clipboardRetired	boolean	true	Indicates whether the Clipboard is retired. This is the case when the latest version of a Clipboard (specified by name, locale, domain) is set to active=false. If latest version is active=true then clipboardRetired is false.	-
policyText	string	true	Policy text for this clipboard.	-
requestRemovalPolicyText	string	true	Policy text for requests for removal of this clipboard.	-
successMessagePolicyText	string	true	Policy text when clipboard is successful.	-
createdAt	string	true	The date and time when the clipboard was created.	-
createdById	string	true	The ID of the user who created the clipboard.	-
updatedAt	string	true	The date and time when the clipboard was updated.	-
updatedById	string	true	The ID of the user who last updated the clipboard.	-

putClipboards

Name	Type	Required	Description	Accepted Values
active	boolean	true	Indicates whether the clipboard can be assigned to users. For a given domain and a given clipboard name, only the most recent version has this flag set to True. If a clipboard is deleted, then for all versions of that clipboard, the active flag is set to False.	-
domain	string	true	The domain of a specific clipboard configuration.	-
locale	string	true	The locale of a specific clipboard configuration.	-
nameFriendly	string	true	The name of the clipboard as displayed to members.	-
policyText	string	false	Policy text for this clipboard.	-
requestRemovalPolicyText	string	false	Policy text for requests for removal of this clipboard.	-
successMessagePolicyText	string	true	Policy text when clipboard is successful.	-
sections	[object]	false	The sections assigned to this clipboard.	-
» id	string	true	The ID of a specific section	-
» position	integer(int32)	false	The position where this section appears in the clipboard	-
updatedById	string	true	User ID of the user updating this resource	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_Clipboard

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific clipboard configuration.	-
domain	string	true	The domain of a specific clipboard configuration.	-
locale	string	true	The locale of a specific clipboard configuration.	-
version	integer(int32)	true	The version of a specific clipboard configuration.	-
active	boolean	true	Indicates whether the clipboard can be assigned to users. For a given domain and a given clipboard name, only the most recent version has this flag set to True. If a clipboard is deleted, then for all versions of that clipboard, the active flag is set to False.	-
orgType	string	false	The organization type of a specific clipboard application configuration.	-
name	string	true	Name of the clipboard.	-
nameFriendly	string	true	The name of the clipboard as displayed to members.	-
clipboardRetired	boolean	true	Indicates whether the Clipboard is retired. This is the case when the latest version of a Clipboard (specified by name, locale, domain) is set to active=false. If latest version is active=true then clipboardRetired is false.	-
policyText	string	true	Policy text for this clipboard.	-
requestRemovalPolicyText	string	true	Policy text for requests for removal of this clipboard.	-
successMessagePolicyText	string	true	Policy text when clipboard is successful.	-
sections	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_SectionReference]	false	The list of sections assigned to this clipboard.	-
createdAt	string	true	The date and time when the clipboard was created.	-
createdById	string	true	The ID of the user who created the clipboard.	-
updatedAt	string	true	The date and time when the clipboard was updated.	-
updatedById	string	true	The ID of the user who last updated the clipboard.	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_SectionReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific section	-
name	string	true	The name of this section	-
description	string	true	The description of this section	-
millenniumDocumentCode	string	false	Cerner Millennium^® document code	-
position	integer(int32)	true	The position where this section appears in the clipboard	-
forms	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_FormReference]	true	An array of forms that are assigned to this section	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_FormReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific form	-
type	string	true	The form type is an enumerated value. The following values are supported: `STANDARD`, `CUSTOM`.	STANDARD, CUSTOM
name	string	true	The name of the clipboard form.	-
nameFriendly	string	true	The form name that is displayed to members.	-
position	integer(int32)	true	The position where the form is displayed in this section.	-

SectionBasics

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

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_SectionBasic

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific section	-
version	integer(int32)	true	The version of a specific section	-
name	string	true	The name of this section	-
description	string	true	The description of this section	-
millenniumDocumentCode	string	false	Cerner Millennium^® document code	-
position	integer(int32)	true	The position where this section appears in the clipboard	-
createdAt	string	true	The date and time when the section was created.	-
createdById	string	true	The ID of the user who created the section	-
updatedAt	string	true	The date and time when the section was updated.	-
updatedById	string	true	The ID of the user who last updated the section	-

postClipboardsClipboardidSections

Name	Type	Required	Description	Accepted Values
name	string	true	The name of this section	-
description	string	true	The description of this section	-
millenniumDocumentCode	string	false	Cerner Millennium^® document code	-
forms	[object]	false	The forms assigned to this section.	-
» type	string	true	The form type is an enumerated value. The following values are supported: `STANDARD`, `CUSTOM`.	-
» id	string	true	The ID of a specific form	-
» position	integer(int32)	false	The position where the form is displayed in this section.	-
createdById	string	true	User ID of the user creating this resource	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_PostSection

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific section	-
clipboardId	string	true	The ID of the clipboard that this section belongs to	-
version	integer(int32)	true	The version of a specific section	-
name	string	true	The name of this section	-
description	string	true	The description of this section	-
millenniumDocumentCode	string	false	Cerner Millennium^® document code	-
position	integer(int32)	true	The position where this section appears in the clipboard	-
createdAt	string	true	The date and time when the section was created.	-
createdById	string	true	The ID of the user who created the section	-
updatedAt	string	true	The date and time when the section was updated.	-
updatedById	string	true	The ID of the user who last updated the section	-
forms	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_PostFormReference]	false	An array of forms that are assigned to this section	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_PostFormReference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific form	-
type	string	true	The form type is an enumerated value. The following values are supported: `STANDARD`, `CUSTOM`.	STANDARD, CUSTOM
position	integer(int32)	true	The position where the form is displayed in this section.	-

putClipboardsClipboardidSections

Name	Type	Required	Description	Accepted Values
description	string	true	The description of this section	-
millenniumDocumentCode	string	false	Cerner Millennium^® document code	-
forms	[object]	false	The forms assigned to this section.	-
» type	string	true	The form type is an enumerated value. The following values are supported: `STANDARD`, `CUSTOM`.	-
» id	string	true	The ID of a specific form	-
» position	integer(int32)	false	The position where the form is displayed in this section.	-
updatedById	string	true	User ID of the user updating this resource	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_GetSection

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific section	-
version	integer(int32)	true	The version of a specific section	-
name	string	true	The name of this section	-
description	string	true	The description of this section	-
millenniumDocumentCode	string	false	Cerner Millennium^® document code	-
position	integer(int32)	true	The position where this section appears in the clipboard	-
forms	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_FormReference]	true	An array of forms that are assigned to this section	-
createdAt	string	true	The date and time when the section was created.	-
createdById	string	true	The ID of the user who created the section	-
updatedAt	string	true	The date and time when the section was updated.	-
updatedById	string	true	The ID of the user who last updated the section	-

RoutingRules

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

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_RoutingRule

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific routing rule	-
clipboardId	string	true	The ID of a specific clipboard	-
appointmentType	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_AppointmentTypeReference	false	A reference to the appointment type information for this routing rule.	-
location	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_LocationReference	false	A reference to the location information for this routing rule.	-
routedRecipient	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_RoutedRecipientReference	false	A reference to the routed recipient for this routing rule.	-
createdAt	string	true	The date and time when the routing rule was created.	-
createdById	string	true	The ID of the user who created the routing rule	-
updatedAt	string	true	The date and time when the routing rule was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_AppointmentTypeReference

Name	Type	Required	Description	Accepted Values
name	string	true	Name of the appointment type	-
code	string	true	Appointment type code	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_LocationReference

Name	Type	Required	Description	Accepted Values
name	string	true	Location of the appointment	-
code	string	true	Location code	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_RoutedRecipientReference

Name	Type	Required	Description	Accepted Values
type	string	false	The recipient type is an enumerated value. The following values are supported: `PERSONNEL`, `POOL`.	PERSONNEL, POOL
id	string	false	The ID of the routed recipient	-

postClipboardsClipboardidRoutingRules

Name	Type	Required	Description	Accepted Values
appointmentType	object	false	A reference to the appointment type information for this routing rule.	-
» name	string	true	Name of the appointment type	-
» code	string	true	Appointment type code	-
location	object	false	A reference to the location information for this routing rule.	-
» name	string	true	Location of the appointment	-
» code	string	true	Location code	-
routedRecipient	object	false	A reference to the routed recipient for this routing rule.	-
» type	string	true	The recipient type is an enumerated value. The following values are supported: `PERSONNEL`, `POOL`.	PERSONNEL, POOL
» id	string	true	The ID of the routed recipient	-
createdById	string	true	User ID of the user creating this resource	-

postClipboardsClipboardidRoutingRulesBulk

Name	Type	Required	Description	Accepted Values
routingRules	[object]	true	The routing rules to be created.	-
» appointmentType	object	false	A reference to the appointment type information for this routing rule.	-
»» name	string	true	Name of the appointment type	-
»» code	string	true	Appointment type code	-
» location	object	false	A reference to the location information for this routing rule.	-
»» name	string	true	Location of the appointment	-
»» code	string	true	Location code	-
» routedRecipient	object	false	A reference to the routed recipient for this routing rule.	-
»» type	string	true	The recipient type is an enumerated value. The following values are supported: `PERSONNEL`, `POOL`.	PERSONNEL, POOL
»» id	string	true	The ID of the routed recipient	-
createdById	string	true	User ID of the user creating this resource	-

StandardForms

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

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_StandardForm

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific form	-
domain	string	true	The domain of a specific standard form	-
locale	string	true	The locale of a specific standard form	-
standardFormType	string	true	The standard form type is an enumerated value. The following values are supported: `ALLERGIES`, `CONDITIONS`, `FAMILY_HISTORY`, `IMMUNIZATIONS`, `MEDICATIONS`, `PROCEDURES`, `SOCIAL_HISTORY`.	ALLERGIES, CONDITIONS, FAMILY_HISTORY, IMMUNIZATIONS, MEDICATIONS, PROCEDURES, SOCIAL_HISTORY
name	string	true	The name of the standard form	-
nameFriendly	string	true	The standard form name that is displayed to members	-
policyText	string	true	The policy text displayed for this form	-
codifiedLists	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_CodifiedList]	true	The list of codified lists	-
allowFreeText	boolean	true	Whether free text can be entered in this form	-
createdAt	string	true	The date and time when the form was created.	-
createdById	string	true	The ID of the user who created the form	-
updatedAt	string	true	The date and time when the form was updated.	-
updatedById	string	true	The ID of the user who last updated the form	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_CodifiedList

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific codified list.	-
name	string	true	The name of the codified list.	-
type	string	true	The codified list is an enumerated value. 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

putClipboardStandardForms

Name	Type	Required	Description	Accepted Values
nameFriendly	string	true	The standard form name that is displayed to members	-
policyText	string	false	The policy text displayed for this form	-
allowFreeText	boolean	true	Whether free text can be entered in this form	-
updatedById	string	true	User ID of the user updating this resource	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_OffsetPaginatedCodifiedChoicesList

Name	Type	Required	Description	Accepted Values
items	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_CodifiedChoiceList]	true	An array containing 1 property where value is a List of Codified Choices.The following keys are supported:`allergies`, `reactions`, `healthIssues`, `proceduresAndSurgeries`, `immunizations`, `familyHistory`.	-
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.	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_CodifiedChoiceList

Name	Type	Required	Description	Accepted Values
allergies	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_AllergiesCodifiedChoice]	false	The list of Allergies Codified Choices	-
reactions	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ReactionsCodifiedChoice]	false	The list of Reactions Codified Choices	-
healthIssues	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ConditionsCodifiedChoice]	false	The list of Conditions Codified Choices	-
proceduresAndSurgeries	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ProceduresAndSurgeriesCodifiedChoice]	false	The list of Procedures and Surgeries Codified Choices	-
immunizations	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ImmunizationsCodifiedChoice]	false	The list of Immunizations Codified Choices	-
familyHistory	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_FamilyHistoryCodifiedChoice]	false	The list of Family History Codified Choices	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_AllergiesCodifiedChoice

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of Allergies Codified Choice	-
nameFriendly	string	false	The name of Allergies Codified Choice to be displayed to user	-
allergyName	string	true	The name of Allergy	-
nomenclatureId	string	true	The NomenclatureID of Allergies Codified Choice	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ReactionsCodifiedChoice

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of Reactions Codified Choice	-
nameFriendly	string	false	The name of Reactions Codified Choice to be displayed to user	-
reactionName	string	true	The name of Reaction	-
nomenclatureId	string	true	The NomenclatureID of Reactions Codified Choice	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ConditionsCodifiedChoice

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of Conditions Codified Choice	-
nameFriendly	string	false	The name of Conditions Codified Choice to be displayed to user	-
healthIssue	string	true	The name of Condition	-
nomenclatureId	string	true	The NomenclatureID of Conditions Codified Choice	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ProceduresAndSurgeriesCodifiedChoice

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of Procedures And Surgeries Codified Choice	-
nameFriendly	string	false	The name of Procedures And Surgeries Codified Choice to be displayed to user	-
procedureName	string	true	The name of a Procedure or Surgery	-
nomenclatureId	string	true	The NomenclatureID of Codified Choice	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ImmunizationsCodifiedChoice

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of Immunizations Codified Choice	-
nameFriendly	string	false	The name of Immunizations Codified Choice to be displayed to user	-
immunizationName	string	true	The name of Immunization	-
eventCode	string	true	The eventCode of Immunizations Codified Choice	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_FamilyHistoryCodifiedChoice

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of Family History Codified Choice	-
nameFriendly	string	false	The name of Family History Codified Choice to be displayed to user	-
conditionName	string	true	The name of Condition	-
category	string	true	The category of Condition	-
nomenclatureId	string	true	The NomenclatureID of Family History Codified Choice	-

postClipboardStandardFormsStandardformidCodifiedListsCodifiedlistidChoicesBulk

Name	Type	Required	Description	Accepted Values
allergies	[object]	false	The codified choices of allergies type to be created.	-
» nameFriendly	string	false	The name of Allergies Codified Choice to be displayed to user	-
» allergyName	string	true	The name of Allergy	-
» nomenclatureId	string	true	The NomenclatureID of Allergies Codified Choice	-
reactions	[object]	false	The codified choices of reactions type to be created.	-
» nameFriendly	string	false	The name of Reactions Codified Choice to be displayed to user	-
» reactionName	string	true	The name of Reaction	-
» nomenclatureId	string	true	The NomenclatureID of Reactions Codified Choice	-
healthIssues	[object]	false	The codified choices of condition type to be created.	-
» nameFriendly	string	false	The name of Conditions Codified Choice to be displayed to user	-
» healthIssue	string	true	The name of Condition	-
» nomenclatureId	string	true	The NomenclatureID of Conditions Codified Choice	-
proceduresAndSurgeries	[object]	false	The codified choices of procedures and surgeries type to be created.	-
» nameFriendly	string	false	The name of Procedures And Surgeries Codified Choice to be displayed to user	-
» procedureName	string	true	The name of a Procedure or Surgery	-
» nomenclatureId	string	true	The NomenclatureID of Codified Choice	-
immunizations	[object]	false	The codified choices of immunizations type to be created.	-
» nameFriendly	string	false	The name of Immunizations Codified Choice to be displayed to user	-
» immunizationName	string	true	The name of Immunization	-
» eventCode	string	true	The eventCode of Immunizations Codified Choice	-
familyHistory	[object]	false	The codified choices of family history type to be created.	-
» nameFriendly	string	false	The name of Family History Codified Choice to be displayed to user	-
» conditionName	string	true	The name of Condition	-
» category	string	true	The category of Condition	-
» nomenclatureId	string	true	The NomenclatureID of Family History Codified Choice	-
createdById	string	true	User ID of the user creating this resource	-

CustomFormListItems

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

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_CustomFormListItem

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific custom form.	-
name	string	true	The name of the custom form.	-
nameFriendly	string	true	The custom form name that is displayed to patients.	-
domain	string	true	The domain of a specific custom form.	-
locale	string	true	The locale of a specific custom form.	-
policyText	string	false	The policy text displayed for this custom form.	-
isSensitive	boolean	false	Whether this custom form contains sensitive content that should not be displayed to authorized representatives (proxy users) of adolescents. Default value: `false`	-
version	integer(int32)	true	The version of a specific custom form.	-
active	boolean	true	Whether this custom form is active.	-
createdById	string	true	The ID of the user who created the custom form.	-
createdAt	string	true	The date and time when the custom form was created.	-
updatedById	string	true	The ID of the user who last updated the custom form.	-
updatedAt	string	true	The date and time when the custom form was updated.	-

postClipboardCustomForms

Name	Type	Required	Description	Accepted Values
createdById	string	true	User ID of the user creating this resource	-
name	string	true	The name of the custom form.	-
nameFriendly	string	true	The custom form name that is displayed to patients.	-
domain	string	true	The domain of a specific custom form.	-
locale	string	true	The locale of a specific custom form.	-
policyText	string	false	The policy text displayed for this custom form.	-
isSensitive	boolean	false	Whether this custom form contains sensitive content that should not be displayed to authorized representatives (proxy users) of adolescents. Default value: `false`	-
contents	[object]	true	An array of contents associated with the custom form.	-
» type	string	true	The content type that is associated with this custom form. The following values are supported: `TEXTBOX`, `QUESTION`.	-
» position	integer(int32)	true	The position in which this content is displayed on the form.	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_CustomForm

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of a specific custom form.	-
name	string	true	The name of the custom form.	-
nameFriendly	string	true	The custom form name that is displayed to patients.	-
domain	string	true	The domain of a specific custom form.	-
locale	string	true	The locale of a specific custom form.	-
policyText	string	false	The policy text displayed for this custom form.	-
isSensitive	boolean	false	Whether this custom form contains sensitive content that should not be displayed to authorized representatives (proxy users) of adolescents. Default value: `false`	-
version	integer(int32)	true	The version of a specific custom form.	-
active	boolean	true	Whether this custom form is active.	-
contents	[PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_ContentReference]	true	An array of contents associated with the custom form.	-
createdById	string	true	The ID of the user who created the custom form.	-
createdAt	string	true	The date and time when the custom form was created.	-
updatedById	string	true	The ID of the user who last updated the custom form.	-
updatedAt	string	true	The date and time when the custom form was updated.	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_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 with this custom form. The following values are supported: `TEXTBOX`, `QUESTION`.	TEXTBOX, QUESTION
fields	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_FieldReference	true	The fields for this specific content.	-
position	integer(int32)	true	The position in which this content is displayed on the form.	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_FieldReference

Name	Type	Required	Description	Accepted Values
text	string	true	The text in the content of this specific text box. This field should be specified only if the content type is `TEXTBOX`.	-
label	string	true	The label for this question. This field should be specified only if the content type is `QUESTION`.	-
isRequired	boolean	true	Whether this question is required. This field should be specified only if the content type is `QUESTION`.	-
isPatientViewableScore	boolean	true	Whether this question is patient viewable. This field should be specified only if the content type is `QUESTION`.	-
dta	PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_DtaReference	true	The DTA reference for this specific content.	-

PatientPortalApplicationPublicApi_Entities_V1_ClipboardConfig_DtaReference

Name	Type	Required	Description	Accepted Values
id	string	true	The discrete task assay (DTA) ID of this question. This field should be specified only if the content type is `QUESTION`.	-
type	string	true	The DTA type for this question. This field should be specified only if the content type is `QUESTION`.	-
eventCode	string	true	The event code for this question. This field should be specified only if the content type is `QUESTION`.	-

putClipboardCustomForms

Name	Type	Required	Description	Accepted Values
nameFriendly	string	true	The custom form name that is displayed to patients.	-
domain	string	true	The domain of a specific custom form.	-
locale	string	true	The locale of a specific custom form.	-
policyText	string	false	The policy text displayed for this custom form.	-
isSensitive	boolean	false	Whether this custom form contains sensitive content that should not be displayed to authorized representatives (proxy users) of adolescents. Default value: `false`	-
active	boolean	false	Whether this custom form is active.	-
contents	[object]	true	An array of contents associated with the custom form.	-
» type	string	true	The content type that is associated with this custom form. The following values are supported: `TEXTBOX`, `QUESTION`.	-
» position	integer(int32)	true	The position in which this content is displayed on the form.	-
updatedById	string	true	User ID of the user updating this resource	-