NAV Navbar
Logo cerner
Ruby Shell

HealtheLife Appointment Type API v1

The HealtheLife Appointment Types API allows tenants to configure and display commonly scheduled appointments for easy user access. This API also allows tenants to market preferred appointment types by displaying them to users scheduling an appointment and by changing the available appointment types to meet the needs of current trends, campaigns, seasonal demands, appointment updates, and more.

URL: https://cernerdemo.api.us-1.healtheintent.com/healthelife_appointment_types/v1

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.

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

print JSON.pretty_generate(result)




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

Example response

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "millenniumAppointmentTypes": [
    {
      "millenniumAppointmentTypeId": "52"
    }
  ]
}

POST /appointment-types

Creates an appointment type.

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 The appointment type was created. AppointmentType
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

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/healthelife_appointment_types/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/healthelife_appointment_types/v1/appointment-types \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
      "createdAt": "2020-01-20T05:40:02.000Z",
      "updatedAt": "2020-01-20T05:40:02.000Z",
      "millenniumAppointmentTypes": [
        {
          "millenniumAppointmentTypeId": "52"
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/healthelife-appointment-types/v1/appointment-types?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/healthelife-appointment-types/v1/appointment-types?offset=0&limit=20"
}

GET /appointment-types

Retrieves a list of all HealtheLife appointment types.

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

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/healthelife_appointment_types/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/healthelife_appointment_types/v1/appointment-types/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /appointment-types/{appointmentTypeId}

Deletes the appointment type associated with the given appointment type ID.

Parameters

Parameter In Type Required Default Description Accepted Values
appointmentTypeId 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/healthelife_appointment_types/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/healthelife_appointment_types/v1/appointment-types/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "262038ed-c304-4737-93d9-55615b6a1cd5",
  "createdAt": "2020-01-20T05:40:02.000Z",
  "updatedAt": "2020-01-20T05:40:02.000Z",
  "millenniumAppointmentTypes": [
    {
      "millenniumAppointmentTypeId": "52"
    }
  ]
}

GET /appointment-types/{appointmentTypeId}

Retrieves the appointment type associated with the given appointment type ID.

Parameters

Parameter In Type Required Default Description Accepted Values
appointmentTypeId 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.

Create a HealtheLife Appointment 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/healthelife_appointment_types/v1/appointment-type-configs', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/healthelife_appointment_types/v1/appointment-type-configs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-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"
}

POST /appointment-type-configs

Creates an appointment configuration.

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 configuration was created. AppointmentTypeConfig
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of HealtheLife Appointment 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/healthelife_appointment_types/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/healthelife_appointment_types/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.healtheintent.com/healthelife-appointment-types/v1/appointment-type-configs?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/healthelife-appointment-types/v1/appointment-type-configs?offset=0&limit=20"
}

GET /appointment-type-configs

Retrieves all the HealtheLife appointment configurations.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A collection of appointment type configurations. AppointmentTypeConfigs
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/healthelife_appointment_types/v1/appointment-type-configs/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)

print JSON.pretty_generate(result)




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

PUT /appointment-type-configs/{appointmentTypeConfigId}

Updates the appointment configuration for a given appointment type configuration ID.

Parameters

Parameter In Type Required Default Description Accepted Values
appointmentTypeConfigId path string true N/A The unique ID of the appointment type configuration ID. -
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/healthelife_appointment_types/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/healthelife_appointment_types/v1/appointment-type-configs/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /appointment-type-configs/{appointmentTypeConfigId}

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

Parameters

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

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/healthelife_appointment_types/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/healthelife_appointment_types/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/{appointmentTypeConfigId}

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

Parameters

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

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

postAppointmentTypes

Name Type Required Description Accepted Values
millenniumAppointments string false The unique IDs for the appointment types in Cerner Millennium. -

AppointmentType

Name Type Required Description Accepted Values
id string true The ID of a specific appointment type. -
createdAt string false The date and time when the resource was created. -
updatedAt string false The date and time when the resource was updated. -
millenniumAppointmentTypes [MillenniumAppointmentId] true The unique IDs for the appointment types in Cerner Millennium. -

MillenniumAppointmentId

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

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

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

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

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

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

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