NAV Navbar
Logo cerner
Ruby Shell

Application Experience API v1

The Application Experience API enables defining and configuring application navigation, content, and branding.

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

Terms And Conditions

The Terms and Conditions endpoints enable customizing and capturing the acceptance of terms and conditions. The endpoints allow interaction with the following resources:

Retrieve a List of Privacy Policies

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/privacy-policies', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "instanceId": "adea0443-60a9-4086-8383-071d1d62210c",
      "privacyPolicyId": "aa07f544-c0cc-49c1-8827-0a770dbb7014",
      "createdAt": "2019-04-16T16:33:29.000Z",
      "content": [
        {
          "locale": "en-US",
          "value": "This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/privacy-policies?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/privacy-policies?offset=0&limit=20"
}

GET /privacy-policies

Retrieves all the available privacy policies for a given HealtheIntent tenant.

Parameters

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

Create a Privacy Policy

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/privacy-policies', headers: headers, body: {"privacyPolicyId":"aa07f544-c0cc-49c1-8827-0a770dbb7014","content":[{"locale":"en-US","value":"This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/application-experience/v1/privacy-policies \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"privacyPolicyId":"aa07f544-c0cc-49c1-8827-0a770dbb7014","content":[{"locale":"en-US","value":"This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."}]}

Example response

{
  "instanceId": "adea0443-60a9-4086-8383-071d1d62210c",
  "privacyPolicyId": "aa07f544-c0cc-49c1-8827-0a770dbb7014",
  "createdAt": "2019-04-16T16:33:29.000Z",
  "content": [
    {
      "locale": "en-US",
      "value": "This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."
    }
  ]
}

POST /privacy-policies

Creates a privacy policy for a given HealtheIntent tenant.

Parameters

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

Response Statuses

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

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created privacy policy.

Remove a Privacy Policy

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /privacy-policies/{instanceId}

Remove a single privacy policy for a given HealtheIntent tenant.

Parameters

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

Response Statuses

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

Retrieve a Single Privacy Policy

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/application-experience/v1/privacy-policies/adea0443-60a9-4086-8383-071d1d62210c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "instanceId": "adea0443-60a9-4086-8383-071d1d62210c",
  "privacyPolicyId": "aa07f544-c0cc-49c1-8827-0a770dbb7014",
  "createdAt": "2019-04-16T16:33:29.000Z",
  "content": [
    {
      "locale": "en-US",
      "value": "This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."
    }
  ]
}

GET /privacy-policies/{instanceId}

Retrieves a single privacy policy for a given HealtheIntent tenant.

Parameters

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

Response Statuses

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

Retrieve a List of Terms Of Use

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "instanceId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
      "touId": "cc71b66a-1d01-47b0-8232-68a986ba63bc",
      "createdAt": "2019-04-16T19:33:29.000Z",
      "content": [
        {
          "locale": "en-US",
          "value": "Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use?offset=0&limit=20"
}

GET /terms-of-use

Retrieves all the available terms of use agreements for a given HealtheIntent tenant.

Parameters

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

Create a Terms Of Use

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use', headers: headers, body: {"touId":"cc71b66a-1d01-47b0-8232-68a986ba63bc","content":[{"locale":"en-US","value":"Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."}]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"touId":"cc71b66a-1d01-47b0-8232-68a986ba63bc","content":[{"locale":"en-US","value":"Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."}]}

Example response

{
  "instanceId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "touId": "cc71b66a-1d01-47b0-8232-68a986ba63bc",
  "createdAt": "2019-04-16T19:33:29.000Z",
  "content": [
    {
      "locale": "en-US",
      "value": "Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."
    }
  ]
}

POST /terms-of-use

Creates a terms of use for a given HealtheIntent tenant.

Parameters

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

Response Statuses

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

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created terms of use.

Remove a Terms Of Use

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /terms-of-use/{instanceId}

Remove a single terms of use for a given HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
instanceId path string true N/A The instance ID of the terms of use. -

Response Statuses

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

Retrieve a Single Terms Of Use

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use/772adbb6-d0c9-46e1-acd5-a5c07c325f88 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "instanceId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "touId": "cc71b66a-1d01-47b0-8232-68a986ba63bc",
  "createdAt": "2019-04-16T19:33:29.000Z",
  "content": [
    {
      "locale": "en-US",
      "value": "Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."
    }
  ]
}

GET /terms-of-use/{instanceId}

Retrieves a single terms of use for a given HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
instanceId path string true N/A The instance ID of the terms of use. -

Response Statuses

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

Retrieve a List of Terms Of Use Acceptances

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use-acceptances', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "699f703a-8095-4c77-90f2-d1385f92c1a7",
      "termsOfUse": {
        "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
      },
      "consumer": {
        "id": "32b567c3-5989-4ca0-96f3-aa63442d2ce1"
      },
      "dateAccepted": "2019-03-31T15:11:53.000Z",
      "domainName": "demo.cernerdemo.us.healtheintent.com"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use-acceptances?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use-acceptances?offset=0&limit=20"
}

GET /terms-of-use-acceptances

Retrieves all the available terms of use acceptances for a given HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId query string false N/A Filters by the ID of the HealtheIntent consumer. -
touId query string false N/A Filters by the ID of the terms of use. -
domainName query string false N/A Filters by the domain name of the terms of use. -
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 TermsOfUseAcceptances
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Create a Terms Of Use Acceptance

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use-acceptances', headers: headers, body: {"termsOfUse":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"},"consumer":{"id":"32b567c3-5989-4ca0-96f3-aa63442d2ce1"},"domainName":"demo.cernerdemo.us.healtheintent.com"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use-acceptances \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"termsOfUse":{"id":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"},"consumer":{"id":"32b567c3-5989-4ca0-96f3-aa63442d2ce1"},"domainName":"demo.cernerdemo.us.healtheintent.com"}

Example response

{
  "id": "699f703a-8095-4c77-90f2-d1385f92c1a7",
  "termsOfUse": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  },
  "consumer": {
    "id": "32b567c3-5989-4ca0-96f3-aa63442d2ce1"
  },
  "dateAccepted": "2019-03-31T15:11:53.000Z",
  "domainName": "demo.cernerdemo.us.healtheintent.com"
}

POST /terms-of-use-acceptances

Creates a terms of use acceptance for a given HealtheIntent tenant.

Parameters

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

Response Statuses

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

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created terms of use acceptance.

Retrieve a Single Terms Of Use Acceptance

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use-acceptances/699f703a-8095-4c77-90f2-d1385f92c1a7', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/application-experience/v1/terms-of-use-acceptances/699f703a-8095-4c77-90f2-d1385f92c1a7 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "699f703a-8095-4c77-90f2-d1385f92c1a7",
  "termsOfUse": {
    "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
  },
  "consumer": {
    "id": "32b567c3-5989-4ca0-96f3-aa63442d2ce1"
  },
  "dateAccepted": "2019-03-31T15:11:53.000Z",
  "domainName": "demo.cernerdemo.us.healtheintent.com"
}

GET /terms-of-use-acceptances/{id}

Retrieves a single terms of use acceptance for a given HealtheIntent tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The instance ID of the terms of use acceptance. -

Response Statuses

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

Role

A role is a label that is applied to a HealtheIntent consumer in the Application Experience service and can be used to provide a contextualized experience based on the role. A HealtheIntent consumer’s roles can change on each site.

Create a Role

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles', headers: headers, body: {"name":"MEMBER"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"MEMBER"}

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "name": "MEMBER"
}

POST /site-roles

Creates a role for a HealtheIntent tenant.

Parameters

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

Response Statuses

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

Response Headers

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

Retrieve a List of Roles

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
      "name": "MEMBER"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles?offset=0&limit=20"
}

GET /site-roles

Retrieves all of the available roles for a HealtheIntent tenant.

Parameters

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

Delete a Role

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles/{roleId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles/{roleId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /site-roles/{roleId}

Deletes a single role for a HealtheIntent tenant.

Parameters

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

Response Statuses

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

Update a Role

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles/{roleId}', headers: headers, body: {"name":"MEMBER"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles/{roleId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"MEMBER"}

PUT /site-roles/{roleId}

Updates a single role for a HealtheIntent tenant.

Parameters

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

Response Statuses

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

Retrieve a Single Role

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles/21fa3619-9569-4ba1-b8fe-95e5f4fc4212', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-roles/21fa3619-9569-4ba1-b8fe-95e5f4fc4212 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
  "name": "MEMBER"
}

GET /site-roles/{roleId}

Retrieves a single role for a HealtheIntent tenant.

Parameters

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

Response Statuses

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

Role Criteria

A role criteria is a rule that maps external labels and IDs such as consumer groups to a specific role. Role criteria can be used to build the rules that determine a role for a HealtheIntent consumer.

Create a Role Criteria

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria', headers: headers, body: {"role":{"id":"2d3ab7ca-30ec-4b59-a24d-506afc25b478","name":"MEMBER"},"kind":"CONSUMER_GROUPS","values":["CONSUMER_GROUP_1","COHORT_3"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"role":{"id":"2d3ab7ca-30ec-4b59-a24d-506afc25b478","name":"MEMBER"},"kind":"CONSUMER_GROUPS","values":["CONSUMER_GROUP_1","COHORT_3"]}

Example response

{
  "roleId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "kind": "CONSUMER_GROUPS",
  "values": [
    "CONSUMER_GROUP_1",
    "COHORT_3"
  ],
  "id": "eea2d24d-a978-4132-afdd-30429789b569",
  "role": {
    "id": "2d3ab7ca-30ec-4b59-a24d-506afc25b478",
    "name": "MEMBER"
  }
}

POST /role-criteria

Creates a role criteria for a role.

Parameters

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

Response Statuses

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

Response Headers

Status Header Type Format Description
201 Location string The location of the newly created role criteria.

Retrieve a List of Role Criteria

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "roleId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
      "kind": "CONSUMER_GROUPS",
      "values": [
        "CONSUMER_GROUP_1",
        "COHORT_3"
      ],
      "id": "eea2d24d-a978-4132-afdd-30429789b569",
      "role": {
        "id": "2d3ab7ca-30ec-4b59-a24d-506afc25b478",
        "name": "MEMBER"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria?offset=0&limit=20"
}

GET /role-criteria

Retrieves all of the available role criteria for a role.

Parameters

Parameter In Type Required Default Description Accepted Values
role query string false N/A Filters by the role resource. -
kind query string false N/A Filters by the kind of role. -
values query array[string] false N/A Filters by role 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 RoleCriteria
400 Bad Request Bad Request BadRequestError
401 Unauthorized Unauthorized UnauthorizedError
403 Forbidden Forbidden ForbiddenError

Delete a Role Criteria

Example Request:


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

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

result = HTTParty.delete('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria/{roleCriteriaId}', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria/{roleCriteriaId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /role-criteria/{roleCriteriaId}

Deletes a single role criteria for a role.

Parameters

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

Response Statuses

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

Update a Role Criteria

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria/{roleCriteriaId}', headers: headers, body: {"role":{"id":"2d3ab7ca-30ec-4b59-a24d-506afc25b478","name":"MEMBER"},"kind":"CONSUMER_GROUPS","values":["CONSUMER_GROUP_1","COHORT_3"]}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria/{roleCriteriaId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"role":{"id":"2d3ab7ca-30ec-4b59-a24d-506afc25b478","name":"MEMBER"},"kind":"CONSUMER_GROUPS","values":["CONSUMER_GROUP_1","COHORT_3"]}

PUT /role-criteria/{roleCriteriaId}

Updates a single role criteria for a role.

Parameters

Parameter In Type Required Default Description Accepted Values
roleCriteriaId path string true N/A The unique ID of the role criteria. -
body body putRoleCriteria true N/A No description -

Response Statuses

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

Retrieve a Single Role Criteria

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/role-criteria/{roleCriteriaId}', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "roleId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "kind": "CONSUMER_GROUPS",
  "values": [
    "CONSUMER_GROUP_1",
    "COHORT_3"
  ],
  "id": "eea2d24d-a978-4132-afdd-30429789b569",
  "role": {
    "id": "2d3ab7ca-30ec-4b59-a24d-506afc25b478",
    "name": "MEMBER"
  }
}

GET /role-criteria/{roleCriteriaId}

Retrieves a single role criteria for a role.

Parameters

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

Response Statuses

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

Consumer Role

A consumer role is the translation from HealtheIntent consumer groups to roles in the Application Experience service. A consumer role resolves a HealtheIntent consumer’s available groups and maps the groups to roles using role criteria.

Retrieve a List of Consumer Roles

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/consumer-roles',
  query: {
  'consumerId' => 'string',
'domainName' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/application-experience/v1/consumer-roles?consumerId=772adbb6-d0c9-46e1-acd5-a5c07c325f88&domainName=cernerdemo.wellness.us.healtheintent.com \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "consumerRoles": [
    {
      "id": "1d3ab7ca-30ec-4b59-a24d-506afc25b476",
      "name": "MEMBER"
    }
  ]
}

GET /consumer-roles

Retrieves the list of consumer roles IDs for the given consumer.

Parameters

Parameter In Type Required Default Description Accepted Values
consumerId query string true N/A The ID of the consumer for whom to look up roles. -
domainName query string true N/A The domain name of the site from which to look up roles. -

Response Statuses

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

Site Definition

A site definition is a set of static configurations that is used when displaying a site. These configurations are the baseline for the site that must be available for every HealtheIntent consumer.

Create a Site Definition

Example Request:




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

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

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-definitions', headers: headers, body: {"siteId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"siteId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}

Example response

{
  "siteDefinitionId": "99e73e70-27fe-4b9f-93f2-0e1e0792b289"
}

POST /site-definitions

Builds a new site definition from a site ID.

Parameters

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

Response Statuses

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

Retrieve a Single Site Definition

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-definitions',
  query: {
  'domainName' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-definitions?domainName=cernerdemo.wellness.us.healtheintent.com \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "siteDefinition": [
    {
      "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
      "name": "WELLNESS",
      "locales": [
        {
          "locale": "en-US",
          "isDefault": "true"
        }
      ],
      "brand": {
        "logo": {
          "src": "https://example.com/logo.png",
          "height": "10",
          "width": "20",
          "altTexts": [
            {
              "text": "English Localized Text",
              "locale": "en-US"
            }
          ]
        },
        "favicons": {
          "iconType": "apple-touch-icon",
          "sizes": "120x120",
          "href": "https://example.com/favicon.png"
        },
        "themes": [
          {
            "name": "Cernerdemo Main Theme",
            "properties": [
              {
                "name": "background-color",
                "value": "#112233"
              }
            ],
            "breakpoint": "HUGE"
          }
        ]
      },
      "identityRealms": [
        {
          "realmId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
          "isDefault": "true",
          "idpKeepAliveUrl": "https://cernerhealth.com/keep-alive"
        }
      ],
      "customScripts": [
        {
          "src": "https://example.com/custom.js",
          "text": "console.log()",
          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC",
          "async": "false",
          "defer": "false"
        }
      ],
      "siteTitles": [
        {
          "text": "English Localized Text",
          "locale": "en-US"
        }
      ],
      "email": "support@example.com",
      "phone": "1112223333",
      "mobile": {
        "appBannerConfig": {
          "ios": {
            "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
            "name": "HealtheLife",
            "deviceType": "Android",
            "enabled": "false",
            "storeId": "com.cerner.wellness.healthypath.play",
            "icon": "http://ip-visprod.northamerica.cerner.net/adobe/SolutionBranding/HealtheLife/LaunchIcons/iOS/HealtheLifePROD/HealtheLife_76.png",
            "bannerTranslations": [
              {
                "title": "HealtheLife App",
                "locale": "en-US"
              }
            ]
          },
          "android": {
            "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
            "name": "HealtheLife",
            "deviceType": "Android",
            "enabled": "false",
            "storeId": "com.cerner.wellness.healthypath.play",
            "icon": "http://ip-visprod.northamerica.cerner.net/adobe/SolutionBranding/HealtheLife/LaunchIcons/iOS/HealtheLifePROD/HealtheLife_76.png",
            "bannerTranslations": [
              {
                "title": "HealtheLife App",
                "locale": "en-US"
              }
            ]
          }
        }
      },
      "privacyPolicy": {
        "instanceId": "adea0443-60a9-4086-8383-071d1d62210c",
        "privacyPolicyId": "aa07f544-c0cc-49c1-8827-0a770dbb7014",
        "createdAt": "2019-04-16T16:33:29.000Z",
        "content": [
          {
            "locale": "en-US",
            "value": "This Privacy Policy (\"Policy\") discloses our information gathering and sharing practices. Your use of Cerner Health is governed by this Policy, and by using or accessing Cerner Health you agree to be bound by its terms. Additional terms and conditions, if any, regarding the collection and use of your information may also be provided to you before you sign up for a particular program, activity, or service."
          }
        ]
      },
      "termsOfUse": [
        {
          "instanceId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
          "touId": "cc71b66a-1d01-47b0-8232-68a986ba63bc",
          "createdAt": "2019-04-16T19:33:29.000Z",
          "content": [
            {
              "locale": "en-US",
              "value": "Cerner Health is offered to you by Cerner Corporation (\"Cerner\"). Your use of Cerner Health is governed by these terms of use (\"Terms\"). If you do not agree to these Terms, you may not establish or use a Cerner Health account. By using or accessing Cerner Health you agree to be bound by these Terms."
            }
          ]
        }
      ],
      "termsOfUseId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
      "roleCriteria": [
        {
          "roleId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
          "kind": "ConsumerGroup",
          "values": [
            "Group1",
            "Group2"
          ]
        }
      ],
      "uniquePageletDomains": [
        "https://s3-us-west-2.amazonaws.com",
        "https://pages.github.com"
      ],
      "alerts": [
        {
          "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
          "messageText": [
            {
              "text": "English Localized Text",
              "locale": "en-US"
            }
          ],
          "expireDate": "2020-06-08"
        }
      ]
    }
  ]
}

GET /site-definitions

Retrieves a site definition record by the domain name.

Parameters

Parameter In Type Required Default Description Accepted Values
domainName query string true N/A The domain name of the site from which to look up the site definition. -

Response Statuses

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

Site Experience

A site experience is a set of contextualized configurations that is used when displaying a site. The contents are specific to a HealtheIntent consumer. These configurations are generated using the consumer role mapping.

Retrieve a Single Site Experience

Example Request:


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

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

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-experiences',
  query: {
  'domainName' => 'string',
'roleIds' => 'array[string]'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/application-experience/v1/site-experiences?domainName=cernerdemo.wellness.us.healtheintent.com&roleIds=772adbb6-d0c9-46e1-acd5-a5c07c325f88 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "siteExperience": [
    {
      "navigation": {
        "primaryNavigation": {
          "name": "Cernerdemo Main Navigation",
          "type": "primary",
          "navItems": [
            {
              "target": "blank",
              "uri": "https://example.com",
              "icon": "https://healtheintent.com/glyph_maps-location_32px_pin-share.svg",
              "title": "Home",
              "navItems": [
                {
                  "target": "blank",
                  "uri": "https://example.com",
                  "icon": "https://healtheintent.com/glyph_maps-location_32px_pin-share.svg",
                  "title": "Home"
                }
              ]
            }
          ]
        },
        "profileNavigation": {
          "name": "Cernerdemo Main Navigation",
          "type": "primary",
          "navItems": [
            {
              "target": "blank",
              "uri": "https://example.com",
              "icon": "https://healtheintent.com/glyph_maps-location_32px_pin-share.svg",
              "title": "Home",
              "navItems": [
                {
                  "target": "blank",
                  "uri": "https://example.com",
                  "icon": "https://healtheintent.com/glyph_maps-location_32px_pin-share.svg",
                  "title": "Home"
                }
              ]
            }
          ]
        },
        "quickNavigation": {
          "name": "Cernerdemo Main Navigation",
          "type": "primary",
          "navItems": [
            {
              "target": "blank",
              "uri": "https://example.com",
              "icon": "https://healtheintent.com/glyph_maps-location_32px_pin-share.svg",
              "title": "Home",
              "navItems": [
                {
                  "target": "blank",
                  "uri": "https://example.com",
                  "icon": "https://healtheintent.com/glyph_maps-location_32px_pin-share.svg",
                  "title": "Home"
                }
              ]
            }
          ]
        }
      },
      "routingGroup": {
        "name": "Cernerdemo Routing",
        "routes": [
          {
            "path": "/pages/home",
            "alias": "home-page",
            "resources": [
              {
                "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f8",
                "page": {
                  "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
                  "name": "Test Page",
                  "defaultConfig": {
                    "rows": [
                      {
                        "height": "auto"
                      }
                    ]
                  },
                  "responsiveConfigs": [
                    {}
                  ],
                  "regions": [
                    {
                      "pageletIds": [
                        "772adbb6-d0c9-46e1-acd5-a5c07c325f88"
                      ],
                      "pagelets": [
                        {
                          "id": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
                          "type": "FRAMED",
                          "config": {
                            "url": "https://example.com",
                            "accessibilityTitle": "Medications",
                            "manifestUrl": "https://example.com/manifest.json",
                            "entryName": "App"
                          }
                        }
                      ],
                      "pageletGap": "auto",
                      "defaultConfig": {
                        "rowStart": "1",
                        "rowEnd": "1",
                        "columnStart": "1",
                        "columnEnd": "1",
                        "styles": {
                          "marginLeft": "1",
                          "marginRight": "1",
                          "marginTop": "1",
                          "marginBottom": "1",
                          "paddingLeft": "1",
                          "paddingRight": "1",
                          "paddingTop": "1",
                          "paddingBottom": "1"
                        }
                      },
                      "responsiveConfigs": [
                        {
                          "config": {
                            "rowStart": "1",
                            "rowEnd": "1",
                            "columnStart": "1",
                            "columnEnd": "1",
                            "styles": {
                              "marginLeft": "1",
                              "marginRight": "1",
                              "marginTop": "1",
                              "marginBottom": "1",
                              "paddingLeft": "1",
                              "paddingRight": "1",
                              "paddingTop": "1",
                              "paddingBottom": "1"
                            }
                          }
                        }
                      ]
                    }
                  ]
                },
                "nativeView": {
                  "root_exposure": {
                    "attribute": null,
                    "options": {
                      "nesting": true
                    },
                    "key": null,
                    "is_safe": null,
                    "for_merge": null,
                    "attr_path_proc": null,
                    "documentation": null,
                    "override": null,
                    "conditions": [],
                    "nested_exposures": [
                      {
                        "attribute": "id",
                        "options": {
                          "expose_nil": false,
                          "documentation": {
                            "type": {},
                            "desc": "The ID of the native view record.",
                            "example": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
                            "require": true
                          }
                        },
                        "key": "id",
                        "is_safe": null,
                        "for_merge": null,
                        "attr_path_proc": null,
                        "documentation": {
                          "type": {},
                          "desc": "The ID of the native view record.",
                          "example": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
                          "require": true
                        },
                        "override": null,
                        "conditions": [
                          {
                            "inverse": true,
                            "block": {}
                          }
                        ]
                      },
                      {
                        "attribute": "alias",
                        "options": {
                          "expose_nil": false,
                          "documentation": {
                            "type": {},
                            "desc": "The native workflow key of the view record.",
                            "example": "messaging_inbox",
                            "require": true
                          }
                        },
                        "key": "alias",
                        "is_safe": null,
                        "for_merge": null,
                        "attr_path_proc": null,
                        "documentation": {
                          "type": {},
                          "desc": "The native workflow key of the view record.",
                          "example": "messaging_inbox",
                          "require": true
                        },
                        "override": null,
                        "conditions": [
                          {
                            "inverse": true,
                            "block": {}
                          }
                        ]
                      }
                    ]
                  },
                  "formatters": {},
                  "block_options": [],
                  "documentation": null,
                  "nesting_stack": []
                },
                "kind": "extensible-app-framework#page"
              }
            ]
          }
        ]
      }
    }
  ]
}

GET /site-experiences

Retrieves a site experience for the given consumer, domain, and locale.

Parameters

Parameter In Type Required Default Description Accepted Values
domainName query string true N/A The domain name of the site from which to look up the site experience. -
roleIds query array[string] true N/A Filters the retrieved site experiences by a list of role IDs. -
locale query string false N/A Filters by the locale of the site experience. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by hyphens. -

Response Statuses

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

Domain

A domain is a mapping between a unique domain name and a specific site definition.

Create or Update a Domain

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com', headers: headers, body: {"siteDefinitionId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/application-experience/v1/domains/cernerdemo.wellness.us.healtheintent.com \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"siteDefinitionId":"772adbb6-d0c9-46e1-acd5-a5c07c325f88"}

PUT /domains/{domainName}

Creates or updates the attributes of a domain record for a given domain name.

Parameters

Parameter In Type Required Default Description Accepted Values
domainName path string true N/A The unique URL of a domain resource. -
body body putDomains true N/A No description -

Response Statuses

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

Retrieve a Single Domain

Example Request:


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

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

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

print JSON.pretty_generate(result)


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

Example response

{
  "siteDefinitionId": "772adbb6-d0c9-46e1-acd5-a5c07c325f88",
  "domainName": "cernerdemo.wellness.us.healtheintent.com"
}

GET /domains/{domainName}

Retrieves a domain record by the domain name.

Parameters

Parameter In Type Required Default Description Accepted Values
domainName path string true N/A The unique URL ID for a domain resource. -

Response Statuses

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

Schema Definitions

ConsumerRole

Name Type Required Description Accepted Values
consumerRoles [Role] true A list of consumer role IDs. -

Role

Name Type Required Description Accepted Values
id string true The unique ID of the role. -
name string true A user-friendly name for the role. -

UnauthorizedError

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [UnauthorizedErrorErrorDetail] 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. -

UnauthorizedErrorErrorDetail

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

ForbiddenError

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

ForbiddenErrorDetail

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

BadRequestError

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

BadRequestErrorDetail

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

putDomains

Name Type Required Description Accepted Values
siteDefinitionId string false The instance ID of the site definition that is applied to this domain -

Domain

Name Type Required Description Accepted Values
siteDefinitionId string false The instance ID of the site definition that is applied to the domain. -
domainName string true The domain name that corresponds to the site. -

NotFoundError

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

NotFoundErrorDetail

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

PrivacyPolicies

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

PrivacyPolicy

Name Type Required Description Accepted Values
instanceId string true The instance ID of the privacy policy. -
privacyPolicyId string true The ID of the privacy policy. The ID can be shared by multiple instances of the same privacy policy. -
createdAt string true The date and time when the privacy policy was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
content [PrivacyPolicyTranslation] false The content of the privacy policy. -

PrivacyPolicyTranslation

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 hyphens. -
value string false The content of the privacy policy for a given locale. -

postPrivacyPolicies

Name Type Required Description Accepted Values
privacyPolicyId string true The ID of the privacy policy. The ID can be shared by multiple instances of the same privacy policy. -
content [object] false The translations of a privacy policy. -
» 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 hyphens. -
» value string true The content of the privacy policy for a given locale. -

postSiteDefinitions

Name Type Required Description Accepted Values
siteId string true The ID of the site used to build a site definition. -

SiteDefinitionPost

Name Type Required Description Accepted Values
siteDefinitionId string true The unique ID that correlates with the site definition. -

SiteDefinition

Name Type Required Description Accepted Values
siteDefinition [SiteDefinitionConfig] true The properties of the site definition. This is an empty array if it is not found. -

SiteDefinitionConfig

Name Type Required Description Accepted Values
id string true The instance ID of the site definition. -
name string true The name of the site. -
locales [Locale] true The list of locales -
brand Brand true The properties of a brand. -
identityRealms [IdentityRealm] true The list of identity realms. -
customScripts [CustomScript] true The list of custom scripts of a brand. -
siteTitles [LocalizedText] true The list of translated titles that are displayed for the site. -
email string true The support email for the client. -
phone string true The support phone number for the client. -
mobile Mobile true The mobile app configurations for the site. -
privacyPolicy PrivacyPolicy false The privacy policy for the site. -
termsOfUse [TermsOfUse] false The list of terms of use agreements for the site. -
termsOfUseId string true The instance ID of the terms of use. -
roleCriteria [RoleCriteria] false The list of role criteria for the site. -
uniquePageletDomains [string] false A list of unique pagelet URLs that corresponds to the site. -
alerts [Alert] false The list of active alerts for the site. -

Locale

Name Type Required Description Accepted Values
locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by hyphens. -
isDefault boolean true Indicates whether the locale is the default. -

Brand

Name Type Required Description Accepted Values
logo Logo true The logo image for the site. -
favicons [Favicon] true A list of favicons of a brand. -
themes [Theme] true A list of themes of a brand. -
topNavigationEnabled boolean true Indicates whether the top navigation of the site is enabled. -

Name Type Required Description Accepted Values
src string false The URL where the logo image is located. -
height integer(int32) true The height of the logo in pixels. -
width integer(int32) true The width of the logo in pixels. -
altTexts [LocalizedText] true A list of localized alt text values. -

LocalizedText

Name Type Required Description Accepted Values
text string true The translated text for the given locale. -
locale string true The locale. Locales must match the ISO 639-1 specification, which uses a two-letter code to identify the language and is separated by hyphens. -

Favicon

Name Type Required Description Accepted Values
iconType string true The type of favicon. -
sizes string false The height and width of the favicon in pixels. -
href string false The URL where the favicon is located. -

Theme

Name Type Required Description Accepted Values
name string false The name of the theme. -
properties [ThemeProperty] true The list of CSS theme properties. -
breakpoint string false The window size breakpoint for which the theme is used. TINY, SMALL, MEDIUM, LARGE, HUGE, DEFAULT

ThemeProperty

Name Type Required Description Accepted Values
name string true The name of the CSS property. -
value string true The value of the CSS property. -

IdentityRealm

Name Type Required Description Accepted Values
realmId string true The ID of the identity realm record. -
isDefault boolean true Indicates whether the identity realm is the default. -
idpKeepAliveUrl string true The URL required to prevent the identity provider (IdP) session from expiring. -

CustomScript

Name Type Required Description Accepted Values
src string false The URL where the custom script is located. -
text string false The raw JavaScript code of the custom script. -
integrity string false The Base64-encoded SHA-384 value that the browser compares with the retrieved custom script for a match. -
async boolean true Indicates whether the browser asynchronously retrieves the custom script while parsing the HTML. -
defer boolean true Indicates whether the browser defers the custom script execution until after the HTML parsing is complete. -

Mobile

Name Type Required Description Accepted Values
appBannerConfig AppBannerConfigs false The mobile app banner configurations for each type of mobile device. -

AppBannerConfigs

Name Type Required Description Accepted Values
ios AppBannerConfig false The configurations of Apple iOS apps. -
android AppBannerConfig false The configurations of Google Android apps. -

AppBannerConfig

Name Type Required Description Accepted Values
id string true The instance ID of the app banner configuration. -
name string true The name of the mobile app. -
deviceType string true The type of mobile device. iOS, Android
enabled boolean true Indicates whether the app banner is enabled. -
storeId string false The ID for the corresponding mobile app. -
icon string false The URL of the mobile app’s icon. -
bannerTranslations [BannerTranslation] true The localized titles for the app banner. -

BannerTranslation

Name Type Required Description Accepted Values
title string true The localized title for a mobile app banner. -
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 hyphens. -

TermsOfUse

Name Type Required Description Accepted Values
instanceId string true The instance ID of the terms of use. -
touId string true The ID of the terms of use. The ID can be shared by multiple instances of the same terms of use. -
createdAt string true The date and time when the terms of use was created, in ISO 8601 YYYY-MM-DDThh:mm:ss.SSSZ format. -
content [TermsOfUseTranslation] false The content of the terms of use. -

TermsOfUseTranslation

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 hyphens. -
value string false The content for the terms of use for a given locale. -

RoleCriteria

Name Type Required Description Accepted Values
roleId string true The ID of the role attached to the role criteria. -
kind string false The type of the resource from an external system from which the values originate. -
values string false An array of values from another product’s resources or models that can be used to build a role criteria. -
id string false The unique ID of the role criteria. -
role RoleReference true The role resource to which a role criteria maps. -

RoleReference

Name Type Required Description Accepted Values
id string true The unique ID of the role. -
name string true A user-friendly name for the role. -

Alert

Name Type Required Description Accepted Values
id string true The instance ID of the alert. -
messageText [LocalizedText] true A list of localized message text values. -
expireDate string true The expiration date of the alert. Uses Year-Month-Day format with leading zeros. -

SiteExperience

Name Type Required Description Accepted Values
siteExperience [SiteExperienceConfig] true The properties of the site experience. This is an empty array if it is not found. -

SiteExperienceConfig

Name Type Required Description Accepted Values
navigation Navigations true The properties of the navigation for the site. -
routingGroup RoutingGroup true The properties of the routing for the site. -

Name Type Required Description Accepted Values
primaryNavigation Navigation true No description -
profileNavigation Navigation true No description -
quickNavigation Navigation false No description -

Name Type Required Description Accepted Values
name string true A short summary for display purposes in administrator tools and to help identify the navigation item when searching for it. -
type string true The purpose of the navigation instance. The following types are possible:
- primary: Indicates the instance that defines the primary navigation.
- profile: Indicates profile navigation links.
- quick: Indicates faster, minimized navigation.
primary, profile, quick
navItems NavigationItem true The list of navigation items at the top level of the navigation instance. -

Name Type Required Description Accepted Values
target string false Specifies where to display the linked URL. The target is a name of, or keyword for, a browsing context such as a tab or window. In-site navigation is used if this is not specified. -
uri string false The URI or path that references the resource to which the navigation item links. -
icon string false The icon resource URL. -
title [string] true The translated text displayed to the user for the navigation item. -
navItems NavigationItem false The list of child navigation items. This is used to create a nested or tree structure for a navigation instance. For example, a Health Record navigation item might have Lab Results and Medications as child navigation items. -

RoutingGroup

Name Type Required Description Accepted Values
name string true A short summary for display purposes in administrator tools and to help identify the routing group when searching for it. -
routes [Route] true No description -

Route

Name Type Required Description Accepted Values
path string true A relative URL path that identifies the resource to display to a user. -
alias string false A named alias that is used to reference a route independent of its path. Aliases can be used to reference a specific route relationship when linking to pages instead of directly referencing the URL. -
resources [RoutingResource] true The list of resources that are accessible on this route. -

RoutingResource

Name Type Required Description Accepted Values
id string true The unique ID of the resource that the route accesses. -
page Page false The page content for the associated resource -
nativeView NativeView false The view content for the associated resource -
kind string true The type of resource that is referenced. -

Page

Name Type Required Description Accepted Values
id string false The ID of the page record. -
name string false Short summary for display purposes in administrator tooling and to help identify when searching. -
defaultConfig PageGridConfig true Default grid configuration. This is applied unless there is a configuration defined for a responsive breakpoint. -
responsiveConfigs [ResponsivePageGridConfig] false Optional region configurations based on responsive breakpoints. This is useful for establishing mobile, tablet and desktop layouts for the page. It is up to the application consuming this page to assign meaning for these breakpoint names. -
regions [Region] true The list of regions within the page. -

PageGridConfig

Name Type Required Description Accepted Values
rows [PageGridRow] true List of rows defined for the page’s grid -

PageGridRow

Name Type Required Description Accepted Values
height string false Height of each row expressed as either ‘auto’ for automatic sizing based on content height or some fixed CSS length per https://developer.mozilla.org/en-US/docs/Web/CSS/length -

ResponsivePageGridConfig

Name Type Required Description Accepted Values
breakpoint string true The name of a point at which a page should switch its display to the given Grid. The name should have meaning to the application consuming this page. TINY, SMALL, MEDIUM, LARGE, HUGE, DEFAULT
config object false No description -
» rows [PageGridRow] true List of rows defined for the page’s grid -

Region

Name Type Required Description Accepted Values
pageletIds [string] true The list of pagelet IDs that should be displayed in this region. When multiple pagelets are included, the pagelets are stacked vertically in the region. -
pagelets [Pagelet] true The associated pagelets found in the region. -
pageletGap string false The amount of spacing applied between pagelets in the region. The value is defined in CSS lengths. See on the MDN Web Docs website for more information. -
defaultConfig RegionConfig true The default region configuration. This is applied unless a configuration is defined for a responsive breakpoint. -
responsiveConfigs [ResponsiveRegionConfig] false Optional region configurations based on responsive breakpoints. This can be used to establish mobile, tablet, and desktop layouts for the page. The application that consumes the page assigns the meaning for the breakpoint names. -

Pagelet

Name Type Required Description Accepted Values
id string false The unique identifier of the pagelet. -
name [string] true Short summary for display purposes in administrator tooling and to help identify when searching -
type [string] true The type of pagelet applied to this instance. framed refers to pagelets that are sandboxed from the application consuming the Extensible App Framework and securely communicate with each other using cross-frame communication (XFC). They are hosted on a domain separate from the application and appear in an HTML iframe. embedded refers to pagelets that are JavaScript & CSS bundles dynamically loaded and inlined into the consuming application without any sandboxing. FRAMED, EMBEDDED
config PageletConfig true Details pertaining to pagelet that define the pagelet. Fields inside the config flex based on the pagelet’s type. -

PageletConfig

Name Type Required Description Accepted Values
url string false Required when type is EMBEDDED. The location where the pagelet is deployed and available for applications to load into a page. -
accessibilityTitle string false Translated names used by screen readers to describe contents of a FRAMED pagelet. -
manifestUrl string false Required when type is EMBEDDED. The location of manifest that defines the assets to load for the bundle. -
entryName string false Required when type is EMBEDDED. Name of the entry file from the manifest that will be loaded for this pagelet. -

RegionConfig

Name Type Required Description Accepted Values
rowStart string true Starting row position for region. The value is in terms of grid lines - not columns. A position of 0 is invalid. See https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-start for more details on the CSS grid spec that this value corresponds to. -
rowEnd string false Ending row position for region. The value is in terms of grid lines - not columns. If this position is left off, then the ending position is assumed to be the starting position and only span a single row. A position of 0 is invalid. See https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-end for more details on the CSS grid spec that this value corresponds to. -
columnStart string false Starting column position for region. The value is in terms of grid lines - not columns. As a result, the 12 equally spaced columns translates into 13 grid lines. The position may fall between 1 and 13 inclusive along with negative values (-13 to -1 inclusive). A position of 0 is invalid. See https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-start for more details on the CSS grid spec that this value corresponds to. -
columnEnd string false Ending column position for region. The value is in terms of grid lines, not columns. As a result, the 12 equally spaced columns translates into 13 grid lines. The position may fall between 1 and 13 inclusive along with negative values (-13 to -1 inclusive). A position of 0 is invalid. A position other than the starting column position will result in spanning multiple columns. See https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-end for more details on the CSS grid spec that this value corresponds to. -
styles Styles false Associated styles found in region -

Styles

Name Type Required Description Accepted Values
marginLeft string false Amount of margin applied from the left side. Value is defined in CSS lengths per https://developer.mozilla.org/en-US/docs/Web/CSS/length -
marginRight string false Amount of margin applied from the right side. Value is defined in CSS lengths per https://developer.mozilla.org/en-US/docs/Web/CSS/length -
marginTop string false Amount of margin applied from the top. Value is defined in CSS lengths per https://developer.mozilla.org/en-US/docs/Web/CSS/length -
marginBottom string false Amount of margin applied from the bottom. Value is defined in CSS lengths per https://developer.mozilla.org/en-US/docs/Web/CSS/length -
paddingLeft string false Amount of padding applied from the left side. Value is defined in CSS lengths per https://developer.mozilla.org/en-US/docs/Web/CSS/length -
paddingRight string false Amount of padding applied from the right side. Value is defined in CSS lengths per https://developer.mozilla.org/en-US/docs/Web/CSS/length -
paddingTop string false Amount of padding applied from the top. Value is defined in CSS lengths per https://developer.mozilla.org/en-US/docs/Web/CSS/length -
paddingBottom string false Amount of padding applied from the bottom. Value is defined in CSS lengths per https://developer.mozilla.org/en-US/docs/Web/CSS/length -

ResponsiveRegionConfig

Name Type Required Description Accepted Values
breakpoint string true The name of a point at which a page should switch its display to the given Grid. The name should have meaning to the application consuming this page. TINY, SMALL, MEDIUM, LARGE, HUGE, DEFAULT
config RegionConfig true Default region configuration. This is applied unless there is a configuration defined for a responsive breakpoint. -

NativeView

Name Type Required Description Accepted Values
id string false The ID of the native view record. -
alias string false The native workflow key of the view record. -

TermsOfUses

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

postTermsOfUse

Name Type Required Description Accepted Values
touId string true The ID of the terms of use. The ID can be shared by multiple instances of the same terms of use. -
content [object] false The translations of a terms of use. -
» 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 hyphens. -
» value string true The content for the terms of use for a given locale. -

TermsOfUseAcceptances

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

TermsOfUseAcceptance

Name Type Required Description Accepted Values
id string true The instance ID of the terms of use acceptance. -
termsOfUse TermsOfUseReference true A reference to the terms of use. -
consumer ConsumerReference true A reference to the HealtheIntent consumer who accepted the terms of use. -
dateAccepted string true The date and time when the terms of use was accepted by the consumer. -
domainName string true The domain for which the terms of use was accepted by the consumer. -

TermsOfUseReference

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

ConsumerReference

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

postTermsOfUseAcceptances

Name Type Required Description Accepted Values
termsOfUse object true A reference to the terms of use. -
» id string true The ID of the terms of use that is accepted. -
consumer object true A reference to the HealtheIntent consumer who accepted the terms of use. -
» id string true The ID of the HealtheIntent consumer. -
domainName string true The domain for which the terms of use was accepted by the consumer. -

postSiteRoles

Name Type Required Description Accepted Values
name string false A user-friendly name for the role. -

Roles

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

putSiteRoles

Name Type Required Description Accepted Values
name string false A user-friendly name for the role. -

postRoleCriteria

Name Type Required Description Accepted Values
role object true The role resource to which a role criteria maps. -
» id string true The unique ID of the role. -
» name string true A user-friendly name for the role. -
kind string false The type of the resource from an external system from which the values originate. -
values [string] true An array of values from another product’s resources or models that can be used to build a role criteria. -

putRoleCriteria

Name Type Required Description Accepted Values
role object true The role resource to which a role criteria maps. -
» id string true The unique ID of the role. -
» name string true A user-friendly name for the role. -
kind string false The type of the resource from an external system from which the values originate. -
values [string] true An array of values from another product’s resources or models that can be used to build a role criteria. -