NAV Navbar
Logo cerner
Ruby Shell

Patient Portal Application Public API v1

The HealtheIntent Patient Portal Application API allows the tenant to configure various features of the Cerner Patient Portal application such as video visits, scheduling, and connections to Cerner Millennium.

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

Cerner Millennium Configuration

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

Retrieve a List of Cerner Millennium OAuth Configurations

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-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'

Example response

{
  "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

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-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}

Example response

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

Update a Cerner Millennium OAuth Configuration

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-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 None
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

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

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-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'

Example response

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

Retrieve a List of Cerner Millennium Configurations

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-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'

Example response

{
  "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. -
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

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-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"}}

Example response

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

Update a Cerner Millennium Configuration

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-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 None
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

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

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-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'

Example response

{
  "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 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:

Retrieve a List of Amwell Configurations

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-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'

Example response

{
  "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"
      }
    }
  ],
  "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

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-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"}}.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"}}

Example response

{
  "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"
  }
}

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

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-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"}}.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"}}

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

Delete an Amwell Configuration

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

Retrieve a Single Amwell Configuration

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-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'

Example response

{
  "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"
  }
}

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

Retrieve a List of Video Visit Configurations

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-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'

Example response

{
  "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."
        }
      ],
      "waitingRoomTexts": [
        {
          "locale": "en-US",
          "content": "Thanks for waiting!"
        }
      ],
      "paymentPageUrl": "https://d1zjhrj0if0ph.cloudfront.net/card-details.html",
      "waitingRoomImageUrl": "https://real-image.cloudfront.net/waitingRoom.jpg",
      "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"
        }
      },
      "healthelifeEnrollmentConfiguration": {
        "healthelifeEnrollmentOrgId": "BHur78nn"
      },
      "millenniumEhrConfiguration": {
        "millenniumPatientConfiguration": {
          "facilityOrganizationId": "6238450",
          "federatedPrincipalPoolId": "677839476"
        },
        "millenniumEncounterConfiguration": {
          "typeCd": "Gbt3fC7",
          "locationId": "JI7934",
          "aliasPoolId": "778GFbv63"
        }
      }
    }
  ],
  "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

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-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."}],"waitingRoomTexts":[{"locale":"en-US","content":"Thanks for waiting!"}],"waitingRoomImageUrl":"https://real-image.cloudfront.net/waitingRoom.jpg","paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"},"healthelifeEnrollmentConfiguration":{"healthelifeEnrollmentOrgId":"BHur78nn"},"millenniumEhrConfiguration":{"millenniumPatientConfiguration":{"facilityOrganizationId":"6238450","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63"}}}.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."}],"waitingRoomTexts":[{"locale":"en-US","content":"Thanks for waiting!"}],"waitingRoomImageUrl":"https://real-image.cloudfront.net/waitingRoom.jpg","paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"},"healthelifeEnrollmentConfiguration":{"healthelifeEnrollmentOrgId":"BHur78nn"},"millenniumEhrConfiguration":{"millenniumPatientConfiguration":{"facilityOrganizationId":"6238450","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63"}}}

Example response

{
  "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."
    }
  ],
  "waitingRoomTexts": [
    {
      "locale": "en-US",
      "content": "Thanks for waiting!"
    }
  ],
  "paymentPageUrl": "https://d1zjhrj0if0ph.cloudfront.net/card-details.html",
  "waitingRoomImageUrl": "https://real-image.cloudfront.net/waitingRoom.jpg",
  "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"
    }
  },
  "healthelifeEnrollmentConfiguration": {
    "healthelifeEnrollmentOrgId": "BHur78nn"
  },
  "millenniumEhrConfiguration": {
    "millenniumPatientConfiguration": {
      "facilityOrganizationId": "6238450",
      "federatedPrincipalPoolId": "677839476"
    },
    "millenniumEncounterConfiguration": {
      "typeCd": "Gbt3fC7",
      "locationId": "JI7934",
      "aliasPoolId": "778GFbv63"
    }
  }
}

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

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-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."}],"waitingRoomTexts":[{"locale":"en-US","content":"Thanks for waiting!"}],"waitingRoomImageUrl":"https://real-image.cloudfront.net/waitingRoom.jpg","paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"},"healthelifeEnrollmentConfiguration":{"healthelifeEnrollmentOrgId":"BHur78nn"},"millenniumEhrConfiguration":{"millenniumPatientConfiguration":{"facilityOrganizationId":"6238450","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63"}}}.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."}],"waitingRoomTexts":[{"locale":"en-US","content":"Thanks for waiting!"}],"waitingRoomImageUrl":"https://real-image.cloudfront.net/waitingRoom.jpg","paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"},"healthelifeEnrollmentConfiguration":{"healthelifeEnrollmentOrgId":"BHur78nn"},"millenniumEhrConfiguration":{"millenniumPatientConfiguration":{"facilityOrganizationId":"6238450","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63"}}}

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 None
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

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

Retrieve a Single Video Visit Configuration

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-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'

Example response

{
  "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."
    }
  ],
  "waitingRoomTexts": [
    {
      "locale": "en-US",
      "content": "Thanks for waiting!"
    }
  ],
  "paymentPageUrl": "https://d1zjhrj0if0ph.cloudfront.net/card-details.html",
  "waitingRoomImageUrl": "https://real-image.cloudfront.net/waitingRoom.jpg",
  "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"
    }
  },
  "healthelifeEnrollmentConfiguration": {
    "healthelifeEnrollmentOrgId": "BHur78nn"
  },
  "millenniumEhrConfiguration": {
    "millenniumPatientConfiguration": {
      "facilityOrganizationId": "6238450",
      "federatedPrincipalPoolId": "677839476"
    },
    "millenniumEncounterConfiguration": {
      "typeCd": "Gbt3fC7",
      "locationId": "JI7934",
      "aliasPoolId": "778GFbv63"
    }
  }
}

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

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-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'

Example response

{
  "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

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-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"}]}

Example response

{
  "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

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

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-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'

Example response

{
  "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 configuring the domains in which appointment types are available.

Retrieve a List of HealtheLife Appointment Type Configurations

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-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'

Example response

{
  "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 is 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

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-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"}

Example response

{
  "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

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

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

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-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'

Example response

{
  "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

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-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'

Example response

{
  "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

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-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"}

Example response

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

Update a Domain Organization Mapping

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

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

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-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'

Example response

{
  "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 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

Example Request:


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]'

Example response

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "patientPortalPersonId": "801930",
      "personIdentifier": "10000143",
      "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

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-1.healtheintent.com/patient-portal-application/v1/activity-logs', headers: headers, body: {"patientPortalPersonId":"801930","feature":"ALLERGIES","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","feature":"ALLERGIES","action":"VIEWED","actionBy":"urn:cerner:identity-federation:realm:ac193c1a-9763-45e1-9fa2-c1c3aa4ba16d:principal:bjones","applicationExperienceDomain":"dev3.healthelife-activity-log-service.com"}

Example response

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "patientPortalPersonId": "801930",
  "personIdentifier": "10000143",
  "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 PostActivityLog
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a HealtheLife Activity Log

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

Activity Logs Configurations

The Activity Logs Configurations endpoints allow tenants to configure the following items:

Retrieve a List of Policy Texts

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create a Policy Text

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-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."}]}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Policy Text

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

Retrieve a Single Policy Text

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a List of Policy Text Configurations

Example Request:


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]'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create an Activity Logs Policy Text

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-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"}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Policy Text Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Update a Policy Text Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Policy Text Configuration

Example Request:


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]'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Allergies Policy Text Configuration

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

Retrieve a List of Policy Texts

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-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'

Example response

{
  "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

Retrieve 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create a Policy Text

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-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."}]}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Policy Text

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

Retrieve a Single Policy Text

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-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'

Example response

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

GET /allergies/policy-texts/{id}

Retrieve 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a List of Policy Text Configurations

Example Request:


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]'

Example response

{
  "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

Retrieve 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create an Allergies Policy Text Configuration

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-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"}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Policy Text Configuration

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-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}

Delete 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Update a Policy Text Configuration

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-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}

Update 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Policy Text Configuration

Example Request:


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]'

Example response

{
  "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}

Retrieve 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Allergies Knowledge Base Configuration

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

Retrieve a List of Knowledge Bases

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-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'

Example response

{
  "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

Retrieve 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create a Knowledge Base

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-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"}]}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Knowledge Base

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

Retrieve a Single Knowledge Base

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-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'

Example response

{
  "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}

Retrieve 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a List of Policy Text Configurations

Example Request:


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]'

Example response

{
  "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

Retrieve 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create Allergies Knowledge Base

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-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"}

Example response

{
  "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

Create 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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Policy Text Configuration

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-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}

Delete 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Update a Policy Text Configuration

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-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}

Update 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Policy Text Configuration

Example Request:


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]'

Example response

{
  "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}

Retrieve 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_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

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-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'

Example response

{
  "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 all the HealtheLife allergies comments configurations 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 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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create a HealtheLife Comments Configuration

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a HealtheLife Allergies Comments Configuration

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-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations', 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 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /allergies/comments-configurations

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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Update a HealtheLife Allergies Comments Configuration

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-1.healtheintent.com/patient-portal-application/v1/allergies/comments-configurations', 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 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /allergies/comments-configurations

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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single HealtheLife Allergies Comments Configuration

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Allergies Configurations

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

Retrieve a List of Allergies Configurations

Example Request:


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]'

Example response

{
  "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"
      }
    }
  ],
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Immunizations Policy Text Configuration

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

Retrieve a List of Policy Texts

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create a Policy Text

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-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."}]}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Policy Text

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

Retrieve a Single Policy Text

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a List of Policy Text Configurations

Example Request:


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]'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create an Immunizations Policy Text

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-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"}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Policy Text Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Update a Policy Text Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Policy Text Configuration

Example Request:


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]'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Immunizations Logo Configuration

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

Retrieve a List of Logos

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

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-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"}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

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

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a List of Logo Configurations

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

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-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"}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Logo Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Update a Logo Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Logo Configuration

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Immunizations Address Configuration

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

Retrieve a List of Addresses

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create an Address

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-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"}]}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete an Address

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

Retrieve a Single Address

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a List of Address Configurations

Example Request:


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]'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create an Immunizations Address

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-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"}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete an Address Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Update an Address Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Address Configuration

Example Request:


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]'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Immunizations Knowledge Base Configuration

The Knowledge Base Configuration endpoints enable tenants to configure the following items:

Retrieve a List of Knowledge Bases

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create a Knowledge Base

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-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"}]}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Knowledge Base

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

Retrieve a Single Knowledge Base

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-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'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a List of Knowledge Base Configurations

Example Request:


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]'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Create an Immunizations Knowledge Base

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-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"}

Example response

{
  "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 HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Delete a Knowledge Base Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Update a Knowledge Base Configuration

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-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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a Single Knowledge Base Configuration

Example Request:


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]'

Example response

{
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Immunizations Configurations

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

Retrieve a List of Immunizations Configurations

Example Request:


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]'

Example response

{
  "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"
            }
          ]
        }
      }
    }
  ],
  "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 HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Schema Definitions

MillenniumOauthConfigurations

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

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 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 identity and access management (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 [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. -

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 Configuration false The associated Cerner Millennium OAuth configuration. -

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

AmwellConfiguration

Name Type Required Description Accepted Values
id string true The ID of the Amwell configuration. -
sdk Sdk false The Amwell SDK configurations required to configure a video visit. -
enrollment Enrollment false The Amwell enrollment configurations required to configure a video visit. -

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

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

postAmwellConfigurations

Name Type Required Description Accepted Values
sdk object true 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 true 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. -

putAmwellConfigurations

Name Type Required Description Accepted Values
sdk object true 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 true 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. -

VideoVisitConfigurationSummaries

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

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 Cerner Patient Portal application that uses the video visit. -
widgetImageUrl string true The URL where the widget image is stored. -
widgetTexts [WidgetTextTranslation] false The content of the widget text. -
waitingRoomTexts [WaitingRoomTextTranslation] false The content of the waiting room. -
paymentPageUrl string true 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. -
amwellConfiguration AmwellConfiguration true The Amwell configuration. -
healthelifeEnrollmentConfiguration HealthelifeEnrollmentConfiguration true The HealtheLife enrollment configuration. -
millenniumEhrConfiguration MillenniumEhrConfiguration true The Millennium Patient configuration. -

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

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

HealthelifeEnrollmentConfiguration

Name Type Required Description Accepted Values
healthelifeEnrollmentOrgId string true The ID that maps a HealtheLife instance to the video visit application. -

MillenniumEhrConfiguration

Name Type Required Description Accepted Values
millenniumPatientConfiguration MillenniumPatientConfiguration false The data required by millennium to save a patient. -
millenniumEncounterConfiguration MillenniumEncounterConfiguration false The Encounter data required by Amwell. -

MillenniumPatientConfiguration

Name Type Required Description Accepted Values
facilityOrganizationId string true The ID of the organization tied to Millennium instance that saves an Amwell patient. -
federatedPrincipalPoolId string true The ID of the Alias pool in Millennium that saves the federated principal of an Amwell patient. -

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

postVideoVisitConfigurations

Name Type Required Description Accepted Values
domain string true The domain name of the Cerner Patient Portal application that uses the video visit. -
widgetImageUrl string true 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. -
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 true The location of the waiting room image file to be embedded in the video visit application. -
paymentPageUrl string true The location of the file to be embedded in the video visit application to handle credit card information. -
amwellConfiguration object true The ID of the Amwell configuration. -
» id string true The ID of the Amwell configuration. -
healthelifeEnrollmentConfiguration object true 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 No description -
»» federatedPrincipalPoolId string true No description -
» millenniumEncounterConfiguration object true No description -
»» typeCd string true No description -
»» locationId string true No description -
»» aliasPoolId string true No description -

putVideoVisitConfigurations

Name Type Required Description Accepted Values
domain string true The domain name of the Cerner Patient Portal application that uses the video visit. -
widgetImageUrl string true 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. -
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 true The location of the waiting room image file to be embedded in the video visit application. -
paymentPageUrl string true The location of the file to be embedded in the video visit application to handle credit card information. -
amwellConfiguration object true The ID of the Amwell configuration. -
» id string true The ID of the Amwell configuration. -
healthelifeEnrollmentConfiguration object true 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 No description -
»» federatedPrincipalPoolId string true No description -
» millenniumEncounterConfiguration object true No description -
»» typeCd string true No description -
»» locationId string true No description -
»» aliasPoolId string true No description -

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

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

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. -
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 ActionByNameEntity true No description -

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 true The Cerner Millennium ID 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. ALLERGIES, IMMUNIZATIONS, RESULTS, CONDITIONS, MEDICATIONS
action string true The action performed in the health record feature in the patient portal application. VIEWED, PRINTED
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. -

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

PolicyText

Name Type Required Description Accepted Values
id string true The unique ID of the policy text associated with the HealtheIntent tenant. -
localeTexts [LocaleTextsEntity] true The locale and text for the locale. -

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

GetPolicyTextConfiguration

Name Type Required Description Accepted Values
id string true The unique ID of the policy text configuration associated with the HealtheIntent 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 PolicyTextsReference true The unique ID of the policy text associated with the HealtheIntent tenant. -

PolicyTextsReference

Name Type Required Description Accepted Values
id string true The unique ID of the policy text. -
localeTexts [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 HealtheIntent tenant ID. -
applicationExperienceDomain string true The ID of the environment of the tenant. -

PostPolicyTextConfiguration

Name Type Required Description Accepted Values
id string true The unique ID of the policy text configuration associated with the HealtheIntent 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 HealtheIntent tenant. -

putActivityLogsPolicyTextConfigurations

Name Type Required Description Accepted Values
policyTextId string true The unique ID of the policy text associated with the HealtheIntent tenant ID. -
applicationExperienceDomain string true The ID of the environment of the tenant. -

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

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

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 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 identifier for the knowledge base associated with the HealtheIntent tenantId. -
applicationExperienceDomain string true The domain to which the tenant ID belongs. -

putImmunizationsKnowledgeBaseConfigurations

Name Type Required Description Accepted Values
knowledgeBaseId string true The unique identifier for the knowledge base associated with the HealtheIntent tenantId. -
applicationExperienceDomain string true The domain to which the tenant ID belongs. -

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

postImmunizationsAddresses

Name Type Required Description Accepted Values
localeAddresses [object] true The locale of the address. -
» locale string true Locale of the address. -
» line1 string true Address of the tenant . -
» line2 string true Address of the tenant . -
» line3 string true Address of the tenant . -
» line4 string true Address of the tenant . -
» line5 string true Address of the tenant . -
» line6 string true Address of the tenant . -

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 identifier for the address associated with the HealtheIntent tenantId. -
applicationExperienceDomain string true The identifier for the environment of the tenant -

putImmunizationsAddressConfigurations

Name Type Required Description Accepted Values
addressId string true The unique identifier for the address associated with the HealtheIntent tenantId. -
applicationExperienceDomain string true The identifier for the environment of the tenant -

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

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 HealtheIntent tenant ID. -
applicationExperienceDomain string true The ID of the environment of the tenant. -

putImmunizationsLogoConfigurations

Name Type Required Description Accepted Values
logoId string true The unique ID of the logo associated with the HealtheIntent tenant ID. -
applicationExperienceDomain string true The ID of the environment of the tenant. -

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

postImmunizationsPolicyTextConfigurations

Name Type Required Description Accepted Values
policyTextId string true The unique ID of the policy text associated with the HealtheIntent tenant ID. -
applicationExperienceDomain string true The ID of the environment of the tenant. -

putImmunizationsPolicyTextConfigurations

Name Type Required Description Accepted Values
policyTextId string true The unique ID of the policy text associated with the HealtheIntent 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. -

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 The identifier indicating if comments is enabled for the environment of the tenant. -
applicationExperienceDomain string true The identifier for the environment of the tenant. -

putAllergiesCommentsConfigurations

Name Type Required Description Accepted Values
enabled boolean true The identifier indicating if comments is enabled for the environment of the tenant. -
applicationExperienceDomain string true The identifier for the environment of the tenant. -

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 Locale code for the tenant. -

postAllergiesKnowledgeBaseConfigurations

Name Type Required Description Accepted Values
knowledgeBaseId string true The unique identifier for the knowledge base associated with the HealtheIntent tenantId. -
applicationExperienceDomain string true The domain to which the tenant ID belongs. -

putAllergiesKnowledgeBaseConfigurations

Name Type Required Description Accepted Values
knowledgeBaseId string true The unique identifier for the knowledge base associated with the HealtheIntent tenantId. -
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. -

postAllergiesPolicyTextConfigurations

Name Type Required Description Accepted Values
policyTextId string true The unique ID of the policy text associated with the HealtheIntent tenant ID. -
applicationExperienceDomain string true The ID of the environment of the tenant. -

putAllergiesPolicyTextConfigurations

Name Type Required Description Accepted Values
policyTextId string true The unique ID of the policy text associated with the HealtheIntent tenant ID. -
applicationExperienceDomain string true The ID of the environment of the tenant. -

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

HealtheintentApi_Common_Models_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 [HealtheintentApi_Common_Models_ErrorDetail] false A list of additional error details. -

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

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

PatientPortalApplicationPublicApi_Entities_V1_AmwellConfiguration

Name Type Required Description Accepted Values
id string true The ID of the Amwell configuration. -
sdk PatientPortalApplicationPublicApi_Entities_V1_Sdk false The Amwell SDK configurations required to configure a video visit. -
enrollment PatientPortalApplicationPublicApi_Entities_V1_Enrollment false The Amwell enrollment configurations required to configure a video visit. -

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

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

PatientPortalApplicationPublicApi_Entities_V1_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 Cerner Patient Portal application that uses the video visit. -
widgetImageUrl string true The URL where the widget image is stored. -
widgetTexts [PatientPortalApplicationPublicApi_Entities_V1_WidgetTextTranslation] false The content of the widget text. -
waitingRoomTexts [PatientPortalApplicationPublicApi_Entities_V1_WaitingRoomTextTranslation] false The content of the waiting room. -
paymentPageUrl string true 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. -
amwellConfiguration PatientPortalApplicationPublicApi_Entities_V1_AmwellConfiguration true The Amwell configuration. -
healthelifeEnrollmentConfiguration PatientPortalApplicationPublicApi_Entities_V1_HealthelifeEnrollmentConfiguration true The HealtheLife enrollment configuration. -
millenniumEhrConfiguration PatientPortalApplicationPublicApi_Entities_V1_MillenniumEhrConfiguration true The Millennium Patient configuration. -

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

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

PatientPortalApplicationPublicApi_Entities_V1_HealthelifeEnrollmentConfiguration

Name Type Required Description Accepted Values
healthelifeEnrollmentOrgId string true The ID that maps a HealtheLife instance to the video visit application. -

PatientPortalApplicationPublicApi_Entities_V1_MillenniumEhrConfiguration

Name Type Required Description Accepted Values
millenniumPatientConfiguration PatientPortalApplicationPublicApi_Entities_V1_MillenniumPatientConfiguration false The data required by Cerner Millennium to save a patient. -
millenniumEncounterConfiguration PatientPortalApplicationPublicApi_Entities_V1_MillenniumEncounterConfiguration false The Encounter data required by Amwell. -

PatientPortalApplicationPublicApi_Entities_V1_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. -
federatedPrincipalPoolId string true The ID of the alias pool in Cerner Millennium in which the federated principal of an Amwell patient is saved. -

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

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_MillenniumAppointmentId] true The unique IDs for the appointment types in Cerner Millennium. -

PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypes_MillenniumAppointmentId

Name Type Required Description Accepted Values
millenniumAppointmentType PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypes_AppointmentTypeReference false The associated Cerner Millennium. -

PatientPortalApplicationPublicApi_Entities_V1_AppointmentTypes_AppointmentTypeReference

Name Type Required Description Accepted Values
id string false The unique Cerner Millennium appointment ID. -

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

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

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

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

PatientPortalApplicationPublicApi_Entities_V1_ActivityLogsConfig_PolicyText

Name Type Required Description Accepted Values
id string true The unique ID of the policy text associated with the HealtheIntent 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. -

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

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 HealtheIntent 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 HealtheIntent tenant. -

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 HealtheIntent tenant. -
knowledgeBaseConfiguration PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetKnowledgeBaseConfiguration false The knowledge base configuration associated with the HealtheIntent tenant. -
logoConfiguration PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetLogoConfiguration false The unique ID of the logo associated with the HealtheIntent tenant. -
addressConfiguration PatientPortalApplicationPublicApi_Entities_V1_Immunizations_GetAddressConfiguration false The unique ID of the address associated with the HealtheIntent 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 HealtheIntent 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 HealtheIntent 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 HealtheIntent 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 HealtheIntent 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 HealtheIntent 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 HealtheIntent 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 HealtheIntent 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 HealtheIntent 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 true Line two of the tenant’s address. -
line3 string true Line three of the tenant’s address. -
line4 string true Line four of the tenant’s address. -
line5 string true Line five of the tenant’s address. -
line6 string true Line six of the tenant’s address. -

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_KnowledgeBase

Name Type Required Description Accepted Values
id string true The unique ID of the knowledge base associated with the HealtheIntent 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. -

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 HealtheIntent 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 HealtheIntent tenant. -

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_Address

Name Type Required Description Accepted Values
id string true The unique ID of the address associated with the HealtheIntent tenant -
localeAddresses [PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleAddressesEntity] true The lines of the address. -

PatientPortalApplicationPublicApi_Entities_V1_Immunizations_PostAddressConfiguration

Name Type Required Description Accepted Values
id string true The unique ID of the address configuration associated with the HealtheIntent 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 HealtheIntent tenant. -

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_PostLogoConfiguration

Name Type Required Description Accepted Values
id string true The unique ID of the logo configuration associated with the HealtheIntent 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 HealtheIntent 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 HealtheIntent tenant -
localeTexts [PatientPortalApplicationPublicApi_Entities_V1_Immunizations_LocaleTextsEntity] true An array of locales and texts. -

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 HealtheIntent 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 HealtheIntent tenant. -

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 HealtheIntent tenant. -
knowledgeBaseConfiguration PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_GetKnowledgeBaseConfiguration false The knowledge base configuration associated with the HealtheIntent tenant. -
commentsConfiguration PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_CommentsConfiguration false The comments configuration associated with the HealtheIntent 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 HealtheIntent 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 HealtheIntent 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 HealtheIntent 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 HealtheIntent 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_KnowledgeBase

Name Type Required Description Accepted Values
id string true The unique ID of the knowledge base associated with the HealtheIntent 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. -

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 HealtheIntent 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 HealtheIntent 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 HealtheIntent tenant -
localeTexts [PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_LocaleTextsEntity] true The locale and text. -

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 HealtheIntent 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 HealtheIntent tenant. -

Done in 0.79s.