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 Amwell settings required to use the Amwell software development kit (SDK).

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",
      "widgetText": [
        {
          "locale": "en-US",
          "value": "Click here to open a video visit."
        }
      ],
      "startPageInstructions": [
        {
          "locale": "en-US",
          "value": "A video visit is an on-demand, real-time video consultation with a physician or provider."
        }
      ],
      "paymentPageUrl": "https://d1zjhrj0if0ph.cloudfront.net/card-details.html",
      "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"
        }
      }
    }
  ],
  "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","widgetText":[{"locale":"en-US","value":"Click here to open a video visit."}],"startPageInstructions":[{"locale":"en-US","value":"A video visit is an on-demand, real-time video consultation with a physician or provider."}],"paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"}}.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","widgetText":[{"locale":"en-US","value":"Click here to open a video visit."}],"startPageInstructions":[{"locale":"en-US","value":"A video visit is an on-demand, real-time video consultation with a physician or provider."}],"paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"}}

Example response

{
  "id": "97b5a802-1447-4f97-af02-7547ac0fc00b",
  "domain": "cckc.patientportal.us.devhealtheintent.com",
  "widgetImageUrl": "https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg",
  "widgetText": [
    {
      "locale": "en-US",
      "value": "Click here to open a video visit."
    }
  ],
  "startPageInstructions": [
    {
      "locale": "en-US",
      "value": "A video visit is an on-demand, real-time video consultation with a physician or provider."
    }
  ],
  "paymentPageUrl": "https://d1zjhrj0if0ph.cloudfront.net/card-details.html",
  "amwellConfiguration": {
    "id": "2daedd88-9b54-4b7e-9303-9db9e8f99f4e"
  }
}

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 VideoVisitConfiguration
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","widgetText":[{"locale":"en-US","value":"Click here to open a video visit."}],"startPageInstructions":[{"locale":"en-US","value":"A video visit is an on-demand, real-time video consultation with a physician or provider."}],"paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"}}.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","widgetText":[{"locale":"en-US","value":"Click here to open a video visit."}],"startPageInstructions":[{"locale":"en-US","value":"A video visit is an on-demand, real-time video consultation with a physician or provider."}],"paymentPageUrl":"https://d1zjhrj0if0ph.cloudfront.net/card-details.html","amwellConfiguration":{"id":"2daedd88-9b54-4b7e-9303-9db9e8f99f4e"}}

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",
  "widgetText": [
    {
      "locale": "en-US",
      "value": "Click here to open a video visit."
    }
  ],
  "startPageInstructions": [
    {
      "locale": "en-US",
      "value": "A video visit is an on-demand, real-time video consultation with a physician or provider."
    }
  ],
  "paymentPageUrl": "https://d1zjhrj0if0ph.cloudfront.net/card-details.html",
  "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"
    }
  }
}

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": [
        {
          "millenniumAppointmentType": {
            "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
          }
        }
      ]
    }
  ],
  "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 in sync with the pagination 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":[{"millenniumAppointmentType":{"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/appointment-types \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"millenniumAppointmentTypes":[{"millenniumAppointmentType":{"id":"f89fa3dd-0000-494b-1111-4640ccc081e3"}}]}

Example response

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "millenniumAppointmentTypes": [
    {
      "millenniumAppointmentType": {
        "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
      }
    }
  ]
}

POST /appointment-types

Creates an HealtheLife Appointment Type with the combination of minimum one and maximum sixMillennium 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 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 given appointment type ID. If the HealtheLife Appointment Type is associated to an Appointment Type Config, 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": [
    {
      "millenniumAppointmentType": {
        "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
      }
    }
  ]
}

GET /appointment-types/{id}

Retrieves the HealtheLife Appointment Type associated with the given 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 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 all the HealtheLife appointment type configurations in sync with the paginationparameters 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 withthe 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. 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 typeconfiguration 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 unique ID of 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 typeconfiguration ID.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A unique ID of 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 typeconfiguration ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A single appointment type configuration. AppointmentTypeConfig
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found 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 patient portal application that uses the video visit. -
widgetImageUrl string true The URL where the widget image is stored. -
widgetText [WidgetTextTranslation] true The content of the widget text. -
startPageInstructions [StartPageInstructionsTranslation] true The content of the start page instructions. -
paymentPageUrl string true The location of the file to be embedded in the video visit application to handle credit card information. -
amwellConfiguration AmwellConfiguration true The Amwell 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. -
value string false The content of the widget text for a given locale. -

StartPageInstructionsTranslation

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. -
value string false The instructions on the start page for a given locale. -

postVideoVisitConfigurations

Name Type Required Description Accepted Values
domain string true The domain name of the patient portal application that uses the video visit. -
widgetImageUrl string true The URL where the widget image is stored. -
widgetText [object] true 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. -
» value string true The content of the widget text for a given locale. -
startPageInstructions [object] true The content of the start page instructions. -
» 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. -
» value string true The instructions on the start page for a given locale. -
paymentPageUrl [string] true The location of the file to be embedded in the video visit application to handle credit card information. -
amwellConfiguration [object] true A reference to the Amwell configuration. -
» id string true The ID of the Amwell configuration. -

VideoVisitConfiguration

Name Type Required Description Accepted Values
id string true The ID of the video visit configuration. -
domain string true The domain name of the patient portal application that uses the video visit. -
widgetImageUrl string true The URL where the widget image is stored. -
widgetText [WidgetTextTranslation] true The content of the widget text. -
startPageInstructions [StartPageInstructionsTranslation] true The content of the start page instructions. -
paymentPageUrl string true The location of the file to be embedded in the video visit application to handle credit card information. -
amwellConfiguration AmwellConfigurationReference true A reference to the Amwell configuration. -

AmwellConfigurationReference

Name Type Required Description Accepted Values
id string true The ID of the Amwell configuration. -

putVideoVisitConfigurations

Name Type Required Description Accepted Values
domain string true The domain name of the patient portal application that uses the video visit. -
widgetImageUrl string true The URL where the widget image is stored. -
widgetText [object] true 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. -
» value string true The content of the widget text for a given locale. -
startPageInstructions [object] true The content of the start page instructions. -
» 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. -
» value string true The instructions on the start page for a given locale. -
paymentPageUrl [string] true The location of the file to be embedded in the video visit application to handle credit card information. -
amwellConfiguration [object] true A reference to the Amwell configuration. -
» id string true The ID of the Amwell configuration. -

AppointmentTypes

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

AppointmentType

Name Type Required Description Accepted Values
id string true The ID of a specific appointment type. -
millenniumAppointmentTypes [MillenniumAppointmentId] true The unique IDs for the appointment types in Cerner Millennium. -

MillenniumAppointmentId

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

AppointmentTypeReference

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

postAppointmentTypes

Name Type Required Description Accepted Values
millenniumAppointmentTypes [object] true Represents an array of millenniumAppointmentTypes. -
» millenniumAppointmentType object true Represents hash of millenniumAppointmentType. -
»» id string true The ID of the Cerner Millennium OAuth configuration. -

AppointmentTypeConfigs

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

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 to be associated 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 to be associated with a domain. -
domainName string true The name of the domain. -