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:
- Cerner Millennium configurations: Cerner Millennium configurations allow tenants to connect to an existing Cerner Millennium domain without protocol. This allows users to retrieve authorization headers, the Cerner Millennium URL, the Patient Portal API URL, and the Cerner Millennium tenant ID, all of which are required to send service requests to the associated Cerner Millennium domain.
- Cerner Millennium OAuth configurations: Cerner Millennium OAuth configurations allow tenants to create and retrieve the OAuth configuration for a given Cerner Millennium domain. This includes storing and updating the consumer key, consumer secret, and Cerner Millennium tenant ID required to send authorized requests to a given Cerner Millennium domain.
Retrieve a List of Cerner Millennium OAuth Configurations
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:
- Amwell configuration: Amwell configurations contain the tenant account information for Amwell and the settings required to use the Amwell software development kit (SDK). This is required for on-demand and scheduled video visits.
- Cerner Millennium EHR configuration: Cerner Millennium electronic health record (EHR) configurations allow tenants to connect patients’ Cerner Millennium medical records with Amwell video visits.
- HealtheLife enrollment configuration: HealtheLife enrollment configurations contain the information required for tenants to save and retrieve information about video visits in the Cerner Patient Portal application.
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",
"mrnAliasPoolId": "4048131",
"mrnAliasTypeCd": "MRN",
"federatedPrincipalPoolId": "677839476"
},
"millenniumEncounterConfiguration": {
"typeCd": "Gbt3fC7",
"locationId": "JI7934",
"aliasPoolId": "778GFbv63",
"finAliasPoolId": "4048132",
"finAliasTypeCd": "FIN NBR"
}
}
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/portal-application/v1/video-visit-configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/portal-application/v1/video-visit-configurations?offset=0&limit=20"
}
GET /video-visit-configurations
Retrieves all the available video visit configurations that satisfy the specified parameters.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
domain | query | string | false | N/A | Filters by the domain of the video visit configuration. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | VideoVisitConfigurationSummaries |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Video Visit Configuration
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","mrnAliasPoolId":"4048131","mrnAliasTypeCd":"MRN","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63","finAliasPoolId":"4048132","finAliasTypeCd":"FIN NBR"}}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/video-visit-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"cckc.patientportal.us.devhealtheintent.com","widgetImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg","widgetTexts":[{"locale":"en-US","content":"Click here to open a video visit."}],"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",
"mrnAliasPoolId": "4048131",
"mrnAliasTypeCd": "MRN",
"federatedPrincipalPoolId": "677839476"
},
"millenniumEncounterConfiguration": {
"typeCd": "Gbt3fC7",
"locationId": "JI7934",
"aliasPoolId": "778GFbv63",
"finAliasPoolId": "4048132",
"finAliasTypeCd": "FIN NBR"
}
}
}
POST /video-visit-configurations
Creates a video visit configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postVideoVisitConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | 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","mrnAliasPoolId":"4048131","mrnAliasTypeCd":"MRN","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63","finAliasPoolId":"4048132","finAliasTypeCd":"FIN NBR"}}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/video-visit-configurations/97b5a802-1447-4f97-af02-7547ac0fc00b \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"domain":"cckc.patientportal.us.devhealtheintent.com","widgetImageUrl":"https://d292eo2ec5lzlq.cloudfront.net/widget-image.jpeg","widgetTexts":[{"locale":"en-US","content":"Click here to open a video visit."}],"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","mrnAliasPoolId":"4048131","mrnAliasTypeCd":"MRN","federatedPrincipalPoolId":"677839476"},"millenniumEncounterConfiguration":{"typeCd":"Gbt3fC7","locationId":"JI7934","aliasPoolId":"778GFbv63","finAliasPoolId":"4048132","finAliasTypeCd":"FIN NBR"}}}
PUT /video-visit-configurations/{id}
Updates a single video visit configuration by its ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the video visit configuration. | - |
body | body | putVideoVisitConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | 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",
"mrnAliasPoolId": "4048131",
"mrnAliasTypeCd": "MRN",
"federatedPrincipalPoolId": "677839476"
},
"millenniumEncounterConfiguration": {
"typeCd": "Gbt3fC7",
"locationId": "JI7934",
"aliasPoolId": "778GFbv63",
"finAliasPoolId": "4048132",
"finAliasTypeCd": "FIN NBR"
}
}
}
GET /video-visit-configurations/{id}
Retrieves a single video visit configuration by its ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the video visit configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Success | VideoVisitConfigurationSummary |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Appointment Notification Record
This endpoint is accessed by a Cerner Millennium operations job and provides the functionality to send a video visit appointment URL in a text message to patients.
Create an Appointment Notification Record
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-notification-records', headers: headers, body: {"patient":{"id":"0727736243092149","name":"John Doe","phoneNumbers":[{"type":"PERSONAL","number":"1234567890","priority":1}]},"provider":{"id":"5047069076338414"},"visit":{"id":"3728638893545894","startDateTime":"2020-08-03T06:10:25.843Z","duration":30}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-notification-records \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"patient":{"id":"0727736243092149","name":"John Doe","phoneNumbers":[{"type":"PERSONAL","number":"1234567890","priority":1}]},"provider":{"id":"5047069076338414"},"visit":{"id":"3728638893545894","startDateTime":"2020-08-03T06:10:25.843Z","duration":30}}
Example response
{
"appointmentUrl": "media.join-appointment-throught-text.com"
}
POST /appointment-notification-records
Creates an appointment notification record.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postAppointmentNotificationRecords | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | AppointmentNotificationResponse |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Response Headers
Status | Header | Type | Format | Description |
---|---|---|---|---|
201 | Location | string | The location of the newly created appointment notification record. |
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",
"identifierType": "MRN",
"featureDetail": "Blood Culture 2020-07-13 12:39:18.pdf",
"applicationExperienceDomain": "dev3.healthelife-activity-log-service.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"featureDisplay": "Allergies",
"actionDisplay": "Viewed",
"actionByName": {
"formatted": "Jones, Bob",
"first": "Bob",
"last": "Jones"
}
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1//activity-logs?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1//activity-logs?offset=0&limit=20"
}
GET /activity-logs
Retrieves a list of all HealtheLife activity logs that is paginated for the specified domain and person.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
Accept-Language | header | string | false | en-US | The locale for the action performed and the feature name in the patient portal application. | - |
applicationExperienceDomain | query | string | true | N/A | The domain name of the tenant in the patient portal application to which the activity logs belong. | - |
patientPortalPersonId | query | string | true | N/A | The Cerner Millennium ID of the patient in the patient portal application on whose EHR the actions were performed and logged. | - |
lookBackMonths | query | integer(int32) | false | 3 | Filters the activity logs to only those from the number of specified look-back months forward. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 25 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of activity logs. | GetActivityLogs |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a HealtheLife Activity Log
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","personIdentifier":"10000252","identifierType":"MRN","feature":"ALLERGIES","featureDetail":"Blood Culture 2020-07-13 12:39:18.pdf","action":"VIEWED","actionBy":"urn:cerner:identity-federation:realm:ac193c1a-9763-45e1-9fa2-c1c3aa4ba16d:principal:bjones","applicationExperienceDomain":"dev3.healthelife-activity-log-service.com"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/activity-logs \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"patientPortalPersonId":"801930","personIdentifier":"10000252","identifierType":"MRN","feature":"ALLERGIES","featureDetail":"Blood Culture 2020-07-13 12:39:18.pdf","action":"VIEWED","actionBy":"urn:cerner:identity-federation:realm:ac193c1a-9763-45e1-9fa2-c1c3aa4ba16d:principal:bjones","applicationExperienceDomain":"dev3.healthelife-activity-log-service.com"}
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"patientPortalPersonId": "801930",
"personIdentifier": "10000143",
"identifierType": "MRN",
"featureDetail": "Blood Culture 2020-07-13 12:39:18.pdf",
"applicationExperienceDomain": "dev3.healthelife-activity-log-service.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"feature": "ALLERGIES",
"action": "VIEWED",
"actionBy": "urn:cerner:identity-federation:realm:ac193c1a-9763-45e1-9fa2-c1c3aa4ba16d:principal:bjones"
}
POST /activity-logs
Creates a HealtheLife activity log for the provided domain and person.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postActivityLogs | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_ActivityLogs_PostActivityLog |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a HealtheLife Activity Log
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 | Deleted | 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:
- Policy Text: Policy texts allow tenants to add the policies/ disclaimer/ important information related to the records or the list displayed to the consumer in the specific language and locale..
- Policy Text Configuration: Policy text configurations allows tenants to configure the domain for the policy text so that the policy text is displayed in that domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.
Retrieve a List of Policy Texts
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:
- Policy Texts: Allergies policy texts enable adding the policies, disclaimer, and other important information related to the allergy records that are displayed to the consumer in the specific language and locale. This allows tenants to create only one policy text for a locale. The locale is the language code, for example,
en-US
. - Policy Text Configurations: Policy text configurations enable configuring application experience domains for policy texts. This includes storing, updating, and deleting the policy text’s association with the application experience domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.
Retrieve a List of Policy Texts
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:
- Knowledge Bases: Knowledge bases enable adding the facility from which the request is made to provide education about allergies. This also allows tenants to add primary search criteria to determine the education information relevant to a specific allergy and the locale to determine the language in which searching is performed.
- Knowledge Base Configurations: Knowledge base configurations enable configuring application experience domains for the knowledge base. This includes storing, updating, and deleting the knowledge base’s association with the application experience domain. One knowledge base can be associated with multiple application experience domains, but one domain cannot be associated with multiple knowledge bases.
Retrieve a List of Knowledge Bases
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 Adolescent Data Flag Configuration
The Allergies Adolescent Data Flag Configuration endpoints enable tenants to configure the adolescent data flag for an application experience domain.This configuration includes storing, updating, and deleting the adolescent data flag configuration associated with the application experience domain. One adolescent data flag configuration can be associated with one application experience domain.
Retrieve a List of HealtheLife Adolescent Data Flag Configurations
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/adolescent-data-flag-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "testapp.com",
"enabled": "true",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations?offset=0&limit=20"
}
GET /allergies/adolescent-data-flag-configurations
Retrieves a list of all the HealtheLife adolescent data flag configurations that 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 adolescent data flag configurations belong. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of comment configurations. | AdolescentDataFlagConfigs |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a HealtheLife Adolescent Data Flag Configuration
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/adolescent-data-flag-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "testapp.com",
"enabled": "true",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
POST /allergies/adolescent-data-flag-configurations
Creates a HealtheLife adolescent data flag configuration by associating the domain with the given adolescent data flag configuration ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postAllergiesAdolescentDataFlagConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | The adolescent data flag configuration was created. | PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_AdolescentDataFlagConfig |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a HealtheLife Adolescent Data Flag Configuration
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/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}
Deletes the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
adolescentDataFlagConfigurationId | path | string | true | N/A | The unique ID of the adolescent data flag configuration associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a HealtheLife Adolescent Data Flag Configuration
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/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}
PUT /allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}
Updates the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID. The domain cannot be updated.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
adolescentDataFlagConfigurationId | path | string | true | N/A | The unique ID of the adolescent data flag configuration associated with the HealtheIntent tenant. | - |
body | body | putAllergiesAdolescentDataFlagConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single HealtheLife Adolescent Data Flag Configuration
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/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "testapp.com",
"enabled": "true",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
GET /allergies/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}
Retrieves the HealtheLife allergies adolescent data flag configuration with the given adolescent data flag configuration ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
adolescentDataFlagConfigurationId | path | string | true | N/A | The unique ID of the adolescent data flag configuration associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single adolescent data flag configuration. | PatientPortalApplicationPublicApi_Entities_V1_AllergiesConfig_AdolescentDataFlagConfig |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Allergies Configurations
The allergies configurations endpoint enables the retrieval of all of the configurations for allergies for the specified application experience domain at the same time.
Retrieve a List of Allergies Configurations
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"
},
"adolescentDataFlagConfiguration": {
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "testapp.com",
"enabled": "true",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/allergies/configurations?offset=0&limit=20"
}
GET /allergies/configurations
Retrieves a list of all the configurations for allergies that is paginated per the specified parameters. The response can also be filtered by domain.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
Accept-Language | header | string | false | en-US | The locale of the configuration. | - |
applicationExperienceDomain | query | string | true | N/A | Filters by the domain to which the tenant ID belongs. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of policy texts. | Configurations |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Immunizations Policy Text Configuration
The Immunizations Policy Text Configuration endpoints enable tenants to configure the following items:
- Policy Texts: Immunizations policy texts enable adding the policies, disclaimer, and other important information related to the allergy records that are displayed to the consumer in the specific language and locale. This allows tenants to create only one policy text for a locale. The locale is the language code, for example,
en-US
. - Policy Text Configurations: Policy text configurations enable configuring application experience domains for policy texts. This includes storing, updating, and deleting the policy text’s association with the application experience domain. Associating the policy text with the domain allows the text to be displayed in that domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.
Retrieve a List of Policy Texts
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:
- Logo: Logos allow tenants to add the logo of the organization that is displayed on the page by specifying the URL. This is mainly used for the purpose of branding.
- Logo Configuration: Logo configurations allow tenants to configure the application experience domain for the logo. This includes storing, updating, and deleting the logo’s association with the application experience domain. One logo can be associated with multiple application experience domains, but one domain cannot be associated with multiple logos.
Retrieve a List of Logos
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 |
Create a Logo
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 |
Delete a Logo
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 |
Retrieve a Single Logo
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 |
Create a Immunizations Logo
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:
- Address: Addresses allow tenants to add the address of the organization that is displayed on the page in the specific language and locale. This is mainly use for the purpose of communication. This enables creating an address by specifying up to six lines that can include an address, phone number, email address, and so on as contact information. Only only one address can be configured for a locale, and the locale is the language code, for example,
en-US
. - Address Configuration: Address configurations allow tenants to configure the application experience domain for the address. This includes storing, updating, and deleting the address’s association with the application experience domain. One address can be associated with multiple application experience domain, but one domain cannot be associated with multiple addresses.
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:
- Knowledge Bases: Knowledge bases enable adding the facility from which the request is made to provide education about immunizations. This also allows tenants to add primary search criteria to determine the education information relevant to a specific immunization and the locale to determine the language in which searching is performed.
- Knowledge Base Configurations: Knowledge base configurationsenable configuring application experience domains for the knowledge base.This includes storing, updating, and deleting the knowledge base’s association withthe application experience domain. One knowledge base can be associated withmultiple application experience domains, but one domain cannot be associated withmultiple knowledge bases.
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 Adolescent Data Flag Configuration
The Immunizations Adolescent Data Flag Configuration endpoints enable tenants to configure the adolescent data flag for an application experience domain.This configuration includes storing, updating, and deleting the adolescent data flag configuration associated with the application experience domain. One adolescent data flag configuration can be associated with one application experience domain.
Retrieve a List of HealtheLife Adolescent Data Flag Configurations
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/adolescent-data-flag-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "testapp.com",
"enabled": true,
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations?offset=0&limit=20"
}
GET /immunizations/adolescent-data-flag-configurations
Retrieves a list of all the HealtheLife adolescent data flag configurations that 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 adolescent data flag configurations belong. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of adolescent data flag configurations. | AdolescentDataFlagConfigs |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a HealtheLife Adolescent Data Flag Configuration
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/adolescent-data-flag-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "testapp.com",
"enabled": true,
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
POST /immunizations/adolescent-data-flag-configurations
Creates a HealtheLife adolescent data flag configuration by associating the domain with the given adolescent data flag configuration ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postImmunizationsAdolescentDataFlagConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | The adolescent data flag configuration was created. | PatientPortalApplicationPublicApi_Entities_V1_Immunizations_AdolescentDataFlagConfig |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a HealtheLife Adolescent Data Flag Configuration
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/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}
Deletes the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
adolescentDataFlagConfigurationId | path | string | true | N/A | The unique ID of the adolescent data flag configuration associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | None |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a HealtheLife Adolescent Data Flag Configuration
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/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","enabled":true}
PUT /immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}
Updates the HealtheLife adolescent data flag configuration with the given adolescent data flag configuration ID. You cannot update the domain.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
adolescentDataFlagConfigurationId | path | string | true | N/A | The unique ID of the adolescent data flag configuration associated with the HealtheIntent tenant. | - |
body | body | putImmunizationsAdolescentDataFlagConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single HealtheLife Adolescent Data Flag Configuration
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/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "testapp.com",
"enabled": true,
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
GET /immunizations/adolescent-data-flag-configurations/{adolescentDataFlagConfigurationId}
Retrieves the HealtheLife immunizations adolescent data flag configuration with the given adolescent data flag configuration ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
adolescentDataFlagConfigurationId | path | string | true | N/A | The unique ID of the adolescent data flag configuration associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single adolescent data flag configuration. | PatientPortalApplicationPublicApi_Entities_V1_Immunizations_AdolescentDataFlagConfig |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Immunizations Configurations
The immunizations configurations endpoint enables the retrieval of all of the configurations for immunizations for the specified application experience domain at the same time.
Retrieve a List of Immunizations Configurations
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"
}
]
}
},
"adolescentDataFlagConfiguration": {
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "testapp.com",
"enabled": true,
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/immunizations/configurations?offset=0&limit=20"
}
GET /immunizations/configurations
Retrieves a list of all the configurations for immunizations that is paginated per the specified parameters. The response can also be filtered by domain.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
Accept-Language | header | string | false | en-US | The locale of the configuration. | - |
applicationExperienceDomain | query | string | true | N/A | The ID of the tenant’s environment. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of policy texts. | AllConfigurations |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Scheduling Configurations
Scheduling configurations allow tenants to configure the following items:
- Policy text definition: Policy text definitions allow tenants to add policies, disclaimers, or other important information related to either the records or to the list that is displayed to the consumer in the specified language and locale.
- Policy text configuration: Policy text configurations allow tenants to configure a domain for a policy text definition so that the policy text is displayed in that domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.
Retrieve a List of Scheduling Policy Text Definitions
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/scheduling-policy-text-definitions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"policyTexts": [
{
"policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
"locale": "en-US",
"text": "Sample Policy Text."
}
],
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions?offset=0&limit=20"
}
GET /scheduling-policy-text-definitions
Retrieves a list of policy text definitions for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of policy texts definitions. | PolicyTextDefinitions |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Scheduling Policy Text Definition
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/scheduling-policy-text-definitions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"policyTexts": [
{
"policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
"locale": "en-US",
"text": "Sample Policy Text."
}
],
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
POST /scheduling-policy-text-definitions
Creates a policy text definition for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postSchedulingPolicyTextDefinitions | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyTextDefinition |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a Scheduling Policy Text Definition
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/scheduling-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /scheduling-policy-text-definitions/{id}
Deletes the scheduling policy text definition with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the policy text definition. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single Scheduling Policy Text Definition
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/scheduling-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"policyTexts": [
{
"policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
"locale": "en-US",
"text": "Sample Policy Text."
}
],
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
GET /scheduling-policy-text-definitions/{id}
Retrieve a single policy text definition for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the policy text definition. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single policy text definition | PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyTextDefinition |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a List of Scheduling Policy Text Configurations
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/scheduling-policy-text-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'
Example response
{
"items": [
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"policyTextDefinition": {
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"policyTexts": [
{
"policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
"locale": "en-US",
"text": "Sample Policy Text."
}
]
},
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations?offset=0&limit=20"
}
GET /scheduling-policy-text-configurations
Retrieves a list of policy text configurations for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Accept-Language | header | string | false | en-US | The locale of the policy text definitions. | - |
applicationExperienceDomain | query | string | false | N/A | The domain to which the tenant ID belongs. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of policy text configurations. | PolicyTextConfigurations |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Scheduling Policy Text Configuration
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/scheduling-policy-text-configurations', headers: headers, body: {"policyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"policyTextDefinition": {
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"policyTexts": [
{
"policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
"locale": "en-US",
"text": "Sample Policy Text."
}
]
},
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
POST /scheduling-policy-text-configurations
Creates a policy text configuration for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postSchedulingPolicyTextConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyTextConfiguration |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a Scheduling Policy Text Configuration
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/scheduling-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /scheduling-policy-text-configurations/{id}
Deletes the policy text configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the policy text configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Scheduling Policy Text Configuration
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/scheduling-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextDefinitionId":"f89fa3dd-0000-494b-1111-4640ccc081e3","applicationExperienceDomain":"dev.healtheintent.net"}
PUT /scheduling-policy-text-configurations/{id}
Updates a policy text configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the policy text configuration. | - |
body | body | putSchedulingPolicyTextConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated | None |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single Scheduling Policy Text Configuration
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/scheduling-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-policy-text-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"policyTextDefinition": {
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"policyTexts": [
{
"policyTextType": "SCHEDULE_APPOINTMENT_VIEW",
"locale": "en-US",
"text": "Sample Policy Text."
}
]
},
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
GET /scheduling-policy-text-configurations/{id}
Retrieves a single policy text configuration for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the policy text configuration. | - |
Accept-Language | header | string | false | en-US | The locale of the policy text definitions. | - |
applicationExperienceDomain | query | string | false | N/A | The domain to which the tenant ID belongs. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single policy text configuration | PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PolicyTextConfiguration |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Scheduling Feature Configurations
The scheduling feature configurations allow tenants to configure the following items:
- Feature definition: Feature definitions allow tenants to configure various features and other scheduling configurations.
- Feature configuration: Feature configurations allow tenants to configure a domain for a feature definition so that the feature definition is displayed in that domain.
Retrieve a List of Scheduling Feature Definitions
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/scheduling-feature-definitions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"cancellationDeadline": 3,
"directBookAppointmentDelay": 3,
"videoVisitVendor": "AMWELL",
"appointmentBookingThreshold": 3,
"directBookContactViaPhoneEnabled": true,
"directBookContactViaMessageEnabled": true,
"npaPortalAccountMinAge": 4,
"npaSsnAliasPoolCode": 2,
"facilityOrganizationId": "12345",
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-definitions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-definitions?offset=0&limit=20"
}
GET /scheduling-feature-definitions
Retrieves a list of feature definitions for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of feature definitions. | FeatureDefinitions |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Scheduling Feature Definition
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/scheduling-feature-definitions', headers: headers, body: {"videoVisitVendor":"AMWELL","cancellationDeadline":2,"appointmentBookingThreshold":2,"requestSchedulingViaMessageEnabled":true,"requestSchedulingViaQueueEnabled":true,"directBookEnabled":true,"guidedSchedulingEnabled":true,"geoLocationEnabled":true,"requestCancelViaMessageEnabled":true,"directBookAppointmentDelay":2,"requestRescheduleEnabled":true,"directCancelEnabled":true,"npaAuthUsersEnabled":true,"npaUnauthUsersEnabled":true,"npaPortalAccountEnabled":true,"npaSsnEnabled":true,"directBookContactViaPhoneEnabled":true,"directBookContactViaMessageEnabled":true,"npaPortalAccountMinAge":2,"npaSsnAliasPoolCode":12,"facilityOrganizationId":"f69fa3dd-0000-494b-1111-4640ddd081e8","npaRequestSchedulingEnabled":true}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"videoVisitVendor":"AMWELL","cancellationDeadline":2,"appointmentBookingThreshold":2,"requestSchedulingViaMessageEnabled":true,"requestSchedulingViaQueueEnabled":true,"directBookEnabled":true,"guidedSchedulingEnabled":true,"geoLocationEnabled":true,"requestCancelViaMessageEnabled":true,"directBookAppointmentDelay":2,"requestRescheduleEnabled":true,"directCancelEnabled":true,"npaAuthUsersEnabled":true,"npaUnauthUsersEnabled":true,"npaPortalAccountEnabled":true,"npaSsnEnabled":true,"directBookContactViaPhoneEnabled":true,"directBookContactViaMessageEnabled":true,"npaPortalAccountMinAge":2,"npaSsnAliasPoolCode":12,"facilityOrganizationId":"f69fa3dd-0000-494b-1111-4640ddd081e8","npaRequestSchedulingEnabled":true}
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"cancellationDeadline": 3,
"directBookAppointmentDelay": 3,
"videoVisitVendor": "AMWELL",
"appointmentBookingThreshold": 3,
"directBookContactViaPhoneEnabled": true,
"directBookContactViaMessageEnabled": true,
"npaPortalAccountMinAge": 4,
"npaSsnAliasPoolCode": 2,
"facilityOrganizationId": "12345",
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
POST /scheduling-feature-definitions
Creates a feature definition for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postSchedulingFeatureDefinitions | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_FeatureDefinition |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a Scheduling Feature Definition
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/scheduling-feature-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /scheduling-feature-definitions/{id}
Deletes the feature definition with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the feature definition. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a List of Scheduling Feature Configurations
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/scheduling-feature-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"applicationExperienceDomain": "dev.healtheintent.com",
"featureDefinition": {
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"cancellationDeadline": 3,
"directBookEnabled": false,
"guidedSchedulingEnabled": false,
"requestSchedulingViaQueueEnabled": false,
"directBookAppointmentDelay": 3,
"requestRescheduleEnabled": false,
"geoLocationEnabled": false,
"videoVisitVendor": "AMWELL",
"requestCancelViaMessageEnabled": false,
"appointmentBookingThreshold": 3,
"requestSchedulingViaMessageEnabled": false,
"directCancelEnabled": false,
"npaAuthUsersEnabled": false,
"npaUnauthUsersEnabled": false,
"npaPortalAccountEnabled": false,
"npaSsnEnabled": false,
"directBookContactViaPhoneEnabled": true,
"directBookContactViaMessageEnabled": true,
"npaPortalAccountMinAge": 4,
"npaSsnAliasPoolCode": 2,
"facilityOrganizationId": "12345",
"npaRequestSchedulingEnabled": false
},
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations?offset=0&limit=20"
}
GET /scheduling-feature-configurations
Retrieves a list of feature configurations for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of feature configurations. | FeatureConfigurations |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Scheduling Feature Configuration
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/scheduling-feature-configurations', headers: headers, body: {"featureDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"featureDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"applicationExperienceDomain": "dev.healtheintent.com",
"featureDefinition": {
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"cancellationDeadline": 3,
"directBookEnabled": false,
"guidedSchedulingEnabled": false,
"requestSchedulingViaQueueEnabled": false,
"directBookAppointmentDelay": 3,
"requestRescheduleEnabled": false,
"geoLocationEnabled": false,
"videoVisitVendor": "AMWELL",
"requestCancelViaMessageEnabled": false,
"appointmentBookingThreshold": 3,
"requestSchedulingViaMessageEnabled": false,
"directCancelEnabled": false,
"npaAuthUsersEnabled": false,
"npaUnauthUsersEnabled": false,
"npaPortalAccountEnabled": false,
"npaSsnEnabled": false,
"directBookContactViaPhoneEnabled": true,
"directBookContactViaMessageEnabled": true,
"npaPortalAccountMinAge": 4,
"npaSsnAliasPoolCode": 2,
"facilityOrganizationId": "12345",
"npaRequestSchedulingEnabled": false
},
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
POST /scheduling-feature-configurations
Creates a feature configuration for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postSchedulingFeatureConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_FeatureConfiguration |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a Scheduling Feature Configuration
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/scheduling-feature-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /scheduling-feature-configurations/{id}
Deletes the feature configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the feature configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Scheduling Feature Configuration
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/scheduling-feature-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"featureDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-feature-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"featureDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}
PUT /scheduling-feature-configurations/{id}
Updates a feature configuration for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the feature configuration. | - |
body | body | putSchedulingFeatureConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated | None |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Scheduling Closed Book Providers
Closed book providers are those who allow direct scheduling only if the patient has an established relationship with them. The scheduling closed book providers endpoints enable tenants to configure the following items:
- Scheduling provider definitions: Provider definitions list the providers who use closed book scheduling.
- Scheduling provider configurations: Provider configurations enable tenants to configure the provider definition for a domain.
Retrieve a List of Scheduling Provider Configurations
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/scheduling-provider-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"applicationExperienceDomain": "cerner.com",
"providerDefinition": {
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"providerIds": [
"1234",
"5678"
],
"providers": [
{
"id": "12345",
"name": "provider"
}
]
},
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations?offset=0&limit=20"
}
GET /scheduling-provider-configurations
Retrieves all the scheduling closed book provider configurations for the HealtheIntent tenant.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
applicationExperienceDomain | query | string | false | N/A | The domain name of the tenant in the patient portal application to which the scheduling configuration belongs. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of provider configurations. | GetProviderConfigurations |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Scheduling Provider Configuration
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/scheduling-provider-configurations', headers: headers, body: {"providerDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"providerDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"providerDefinitionId": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"applicationExperienceDomain": "cerner.com",
"createdAt": "2020-08-03T06:10:25.843Z",
"updatedAt": "2020-08-03T06:10:25.843Z"
}
POST /scheduling-provider-configurations
Creates a provider configuration for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postSchedulingProviderConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_PostProviderConfiguration |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Update a Scheduling Provider Configuration
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/scheduling-provider-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"providerDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"providerDefinitionId":"2bab765b-cbeb-40ef-b557-540ab3841cdf","applicationExperienceDomain":"dev.healtheintent.com"}
PUT /scheduling-provider-configurations/{id}
Updates the scheduling provider configuration with the given ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the provider configuration. | - |
body | body | putSchedulingProviderConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated | None |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Delete a Scheduling Provider Configuration
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/scheduling-provider-configurations/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-configurations/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /scheduling-provider-configurations/{id}
Deletes the scheduling provider configuration with the given ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the provider configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a List of Scheduling Provider Definitions
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/scheduling-provider-definitions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"providerIds": [
"1234",
"5678"
],
"providers": [
{
"id": "12345",
"name": "provider"
}
],
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-definitions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-definitions?offset=0&limit=20"
}
GET /scheduling-provider-definitions
Retrieves a list of provider definitions for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of provider definitions. | ProviderDefinitions |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Scheduling Provider Definition
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/scheduling-provider-definitions', headers: headers, body: {"providers":[{"id":"12345","name":"provider"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"providers":[{"id":"12345","name":"provider"}]}
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"providerIds": [
"1234",
"5678"
],
"providers": [
{
"id": "12345",
"name": "provider"
}
],
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
POST /scheduling-provider-definitions
Creates a provider definition for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postSchedulingProviderDefinitions | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_SchedulingConfig_ProviderDefinition |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a Scheduling Provider Definition
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/scheduling-provider-definitions/e92ca89f-8524-451a-9346-666d6ff39329', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-provider-definitions/e92ca89f-8524-451a-9346-666d6ff39329 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /scheduling-provider-definitions/{id}
Deletes the provider definition with the given provider definition ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The unique ID of the provider definition. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Guided Scheduling
The guided scheduling endpoints enable tenants to configure the questionnaire used to guide consumers through the process of scheduling appointments in a domain. Guided scheduling uses the following resources:
- Guided Scheduling Definitions: Guided scheduling definitions enable tenants to define the questionnaire questions and answers for guided scheduling in a domain and the rules that determine when questions are displayed.
- Guided Scheduling Configurations: Guided scheduling configurations enable tenants to configure the guided scheduling definition and questionnaire that is used in a domain.
Retrieve a List of Guided Scheduling Configurations
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/guided-scheduling-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "987651ed-c304-4737-93d9-78615b6a1pa2",
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z",
"questionnaires": [
{
"id": "987651ed-c304-4737-93d9-78615b6a1pa2",
"name": "Cerner Guided Scheduling Questionnaire",
"locale": "en-US",
"description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."
}
]
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations?offset=0&limit=20"
}
GET /guided-scheduling-configurations
Retrieves all the guided scheduling configurations.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
applicationExperienceDomain | query | string | false | N/A | The domain name of the tenant in the patient portal application to which the guided scheduling configuration belongs. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | GetGuidedConfigurations |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Guided Scheduling Configuration
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/guided-scheduling-configurations', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","questionnaires":[{"id":"4axc897s-polq-98eq-b597-789aa3871pls"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","questionnaires":[{"id":"4axc897s-polq-98eq-b597-789aa3871pls"}]}
Example response
{
"id": "987651ed-c304-4737-93d9-78615b6a1pa2",
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z",
"questionnaires": [
{
"id": "4axc897s-polq-98eq-b597-789aa3871pls"
}
]
}
POST /guided-scheduling-configurations
Creates a new guided scheduling configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postGuidedSchedulingConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_PostGuidedConfigurations |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a Single Guided Scheduling Configuration
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/guided-scheduling-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "987651ed-c304-4737-93d9-78615b6a1pa2",
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z",
"questionnaires": [
{
"id": "987651ed-c304-4737-93d9-78615b6a1pa2",
"name": "Cerner Guided Scheduling Questionnaire",
"locale": "en-US",
"description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."
}
]
}
GET /guided-scheduling-configurations/{id}
Retrieves the guided scheduling configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the guided scheduling configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | GetGuidedConfigurations |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Update a Guided Scheduling Configuration
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/guided-scheduling-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"applicationExperienceDomain":"dev.healtheintent.com","questionnaires":[{"id":"4axc897s-polq-98eq-b597-789aa3871pls"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/guided-scheduling-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"applicationExperienceDomain":"dev.healtheintent.com","questionnaires":[{"id":"4axc897s-polq-98eq-b597-789aa3871pls"}]}
PUT /guided-scheduling-configurations/{id}
Updates the guided scheduling configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the guided scheduling configuration. | - |
body | body | putGuidedSchedulingConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Delete a Guided Scheduling Configuration
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/guided-scheduling-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/guided-scheduling-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /guided-scheduling-configurations/{id}
Deletes the guided scheduling configuration with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the guided scheduling configuration. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Create a Guided Scheduling Questionnaire
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/scheduling-questionnaires', headers: headers, body: {"name":"Cerner Guided Scheduling Questionnaire","locale":"en-US","description":"Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cerner Guided Scheduling Questionnaire","locale":"en-US","description":"Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."}
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"name": "Cerner Guided Scheduling Questionnaire",
"locale": "en-US",
"description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users.",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
POST /scheduling-questionnaires
Creates a new guided scheduling questionnaire for the guided scheduling definition.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postSchedulingQuestionnaires | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_PostQuestionnaires |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a List of Guided Scheduling Questionnaires
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/scheduling-questionnaires', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"name": "Cerner Guided Scheduling Questionnaire",
"locale": "en-US",
"description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users.",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires?offset=0&limit=20"
}
GET /scheduling-questionnaires
Retrieve all the guided scheduling questionnaires for the guided scheduling definition.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | GetQuestionnaires |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a Single Guided Scheduling Questionnaire
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/scheduling-questionnaires/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"locale": "en-US",
"name": "Cerner Guided Scheduling Questionnaire",
"description": "Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users.",
"questions": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"text": "Are you a new patient or an established patient?",
"options": [
{
"id": "675411oo-f123-8907-93d3-2375b6a1cd5",
"text": "New Patient",
"appointmentType": {
"appointmentSynonymCode": "703265169"
}
}
],
"rules": [
{
"question": {
"id": "78bc3048-fb35-46a9-88e5-66f61993a969"
},
"option": {
"id": "d3c30094-7a02-42b8-9006-95fada46b865"
}
}
]
}
],
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
GET /scheduling-questionnaires/{questionnaireId}
Retrieves the guided scheduling questionnaire with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
questionnaireId | path | string | true | N/A | The ID of the Guided Scheduling Questionnaire. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieve a Single Guided Scheduling Questionnaire | PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_GetQuestionnairesId |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Guided Scheduling Questionnaire
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/scheduling-questionnaires/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"name":"Cerner Guided Scheduling Questionnaire","locale":"en-US","description":"Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cerner Guided Scheduling Questionnaire","locale":"en-US","description":"Questionnaire used to suggest an appointment and guide scheduling for Cerner *HealtheLife* portal users."}
PUT /scheduling-questionnaires/{questionnaireId}
Update the guided scheduling questionnaire with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
questionnaireId | path | string | true | N/A | The ID of the Guided Scheduling Questionnaire. | - |
body | body | putSchedulingQuestionnaires | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Delete a Guided Scheduling Questionnaire
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/scheduling-questionnaires/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/scheduling-questionnaires/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /scheduling-questionnaires/{questionnaireId}
Deletes the guided scheduling questionnaire with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
questionnaireId | path | string | true | N/A | The ID of the Guided Scheduling Questionnaire. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Create a Guided Scheduling Question
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions', headers: headers, body: {"questions":[{"text":"Are you a new patient or an established patient?","options":[{"text":"Yes"},{"text":"No"}]}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"questions":[{"text":"Are you a new patient or an established patient?","options":[{"text":"Yes"},{"text":"No"}]}]}
Example response
{
"questions": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"text": "Are you a new patient or an established patient?",
"options": [
{
"id": "784413ps-c924-4737-93f9-52315s6a1qw5",
"text": "Yes"
},
{
"id": "312456ps-c112-1237-22f9-34515s6a1ax5",
"text": "No"
}
],
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
]
}
POST /scheduling-questionnaires/{questionnaireId}/questions
Create a new set of guided scheduling questions for the guided scheduling definition.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
questionnaireId | path | string | true | N/A | The ID of the Guided Scheduling Questionnaire. | - |
body | body | postSchedulingQuestionnairesQuestionnaireidQuestions | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_PostQuestionnairesQuestions |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a List of Guided Scheduling Questions
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"text": "Are you a new patient or an established patient?",
"options": [
{
"id": "784413ps-c924-4737-93f9-52315s6a1qw5",
"text": "Yes"
},
{
"id": "312456ps-c112-1237-22f9-34515s6a1ax5",
"text": "No"
}
],
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/questionnaire_id/questions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/questionnaire_id/questions?offset=0&limit=20"
}
GET /scheduling-questionnaires/{questionnaireId}/questions
Retrieve all the guided scheduling questions for the guided scheduling definition.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
questionnaireId | path | string | true | N/A | The ID of the Guided Scheduling Questionnaire. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | GetQuestionnairesQuestions |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Update a Guided Scheduling Question
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"text":"Are you a new patient or an established patient?","options":[{"id":"784413ps-c924-4737-93f9-52315s6a1qw5","text":"Yes"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"text":"Are you a new patient or an established patient?","options":[{"id":"784413ps-c924-4737-93f9-52315s6a1qw5","text":"Yes"}]}
PUT /scheduling-questionnaires/{questionnaireId}/questions/{id}
Updates the guided scheduling question with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the guided scheduling questionnaire question. | - |
questionnaireId | path | integer(int32) | true | N/A | No description | - |
body | body | putSchedulingQuestionnairesQuestionnaireidQuestions | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Delete a Guided Scheduling Question
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions/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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /scheduling-questionnaires/{questionnaireId}/questions/{id}
Deletes the guided scheduling question with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the guided scheduling questionnaire question. | - |
questionnaireId | path | integer(int32) | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single Guided Scheduling Question
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/questions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"text": "Are you a new patient or an established patient?",
"options": [
{
"id": "784413ps-c924-4737-93f9-52315s6a1qw5",
"text": "Yes"
},
{
"id": "312456ps-c112-1237-22f9-34515s6a1ax5",
"text": "No"
}
],
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
GET /scheduling-questionnaires/{questionnaireId}/questions/{id}
Retrieves the guided scheduling question with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the guided scheduling questionnaire question. | - |
questionnaireId | path | integer(int32) | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_GetQuestionnairesQuestions |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Create a Guided Scheduling Rule
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules', headers: headers, body: {"rules":[{"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"},"appointmentType":{}},{"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"appointmentType":{"appointmentSynonymCode":"703265169"},"linkedQuestion":{}}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"rules":[{"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"},"appointmentType":{}},{"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"appointmentType":{"appointmentSynonymCode":"703265169"},"linkedQuestion":{}}]}
Example response
{
"rules": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"question": {
"id": "78bc3048-fb35-46a9-88e5-66f61993a969"
},
"option": {
"id": "d3c30094-7a02-42b8-9006-95fada46b865"
},
"linkedQuestion": {
"id": "487038rf-h123-5557-93e9-90815b6a1cd5"
},
"appointmentType": {
"appointmentSynonymCode": "703265169"
},
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
},
{
"id": "p09543w1-aef5-493c-3r54-dfd842c2as56",
"question": {
"id": "78bc3048-fb35-46a9-88e5-66f61993a969"
},
"option": {
"id": "d3c30094-7a02-42b8-9006-95fada46b865"
},
"appointmentType": {
"appointmentSynonymCode": "703265169"
},
"linkedQuestion": {
"id": "487038rf-h123-5557-93e9-90815b6a1cd5"
},
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
]
}
POST /scheduling-questionnaires/{questionnaireId}/rules
Creates a new guided scheduling rule.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
questionnaireId | path | string | true | N/A | The ID of the Guided Scheduling Questionnaire. | - |
body | body | postSchedulingQuestionnairesQuestionnaireidRules | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_PostQuestionnaireRules |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Retrieve a List of Guided Scheduling Rules
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"question": {
"id": "78bc3048-fb35-46a9-88e5-66f61993a969"
},
"option": {
"id": "d3c30094-7a02-42b8-9006-95fada46b865"
},
"linkedQuestion": {
"id": "487038rf-h123-5557-93e9-90815b6a1cd5"
},
"appointmentType": {
"appointmentSynonymCode": "703265169"
},
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/questionnaire_id/rules?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/questionnaire_id/rules?offset=0&limit=20"
}
GET /scheduling-questionnaires/{questionnaireId}/rules
Retrieves all the guided scheduling rules.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
questionnaireId | path | string | true | N/A | The ID of the Guided Scheduling Questionnaire. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | GetQuestionnaireRules |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Get a Guided Scheduling Rule by ID
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"question": {
"id": "78bc3048-fb35-46a9-88e5-66f61993a969"
},
"option": {
"id": "d3c30094-7a02-42b8-9006-95fada46b865"
},
"linkedQuestion": {
"id": "487038rf-h123-5557-93e9-90815b6a1cd5"
},
"appointmentType": {
"appointmentSynonymCode": "703265169"
},
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
GET /scheduling-questionnaires/{questionnaireId}/rules/{id}
Retrieves a single Guided Scheduling Rule
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
questionnaireId | path | integer(int32) | true | N/A | No description | - |
id | path | integer(int32) | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | PatientPortalApplicationPublicApi_Entities_V1_GuidedSchedulingConfig_GetQuestionnaireRules |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Update a Guided Scheduling Rule
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"},"appointmentType":{"appointmentSynonymCode":"703265169"}}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"question":{"id":"78bc3048-fb35-46a9-88e5-66f61993a969"},"option":{"id":"d3c30094-7a02-42b8-9006-95fada46b865"},"linkedQuestion":{"id":"487038rf-h123-5557-93e9-90815b6a1cd5"},"appointmentType":{"appointmentSynonymCode":"703265169"}}
PUT /scheduling-questionnaires/{questionnaireId}/rules/{id}
Updates the guided scheduling rule with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the guided scheduling questionnaire rule. | - |
questionnaireId | path | integer(int32) | true | N/A | No description | - |
body | body | putSchedulingQuestionnairesQuestionnaireidRules | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Delete a Guided Scheduling Rule
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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules/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/scheduling-questionnaires/67ab765b-cbeb-40ef-b557-540ab3841cdf/rules/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /scheduling-questionnaires/{questionnaireId}/rules/{id}
Deletes the guided scheduling rule with the specified ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
id | path | string | true | N/A | The ID of the guided scheduling questionnaire rule. | - |
questionnaireId | path | integer(int32) | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Scheduling Geolocations
The scheduling geolocation endpoints allow you to configure appointment locations and retrieve the nearest appointment locations for a patient for a given tenant. The following items can be configured and retrieved using the endpoints:
- Load Appointment Locations: You can create a list of appointment locations in bulk and override the existing data.
- Appointment Locations:You can retrieve the appointment locations for a given HealtheIntent tenant.
Retrieve a List of Appointment Locations
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/scheduling-appointment-locations',
query: {
'applicationExperienceDomain' => 'string'
}, headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-appointment-locations?applicationExperienceDomain=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"applicationExperienceDomain": "dev.us.healtheintent.com",
"locationId": "26222027",
"name": "Cerner Clinic",
"phone": "0000000000",
"phoneExt": "800",
"street1": "2800 Rock Creek Pkwy",
"street2": "street2",
"street3": "street3",
"street4": "street4",
"city": "Kansas City",
"state": "MO",
"postalCode": "WDR454",
"country": "USA",
"latitude": "12.67",
"longitude": "17.76",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-appointment-locations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-appointment-locations?offset=0&limit=20"
}
GET /scheduling-appointment-locations
Retrieves all of the appointment locations for the given HealtheIntent tenant ID.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
applicationExperienceDomain | query | string | true | N/A | The domain name of a tenant in the patient portal application that uses the geolocation service. | - |
sourceLocation | query | string | false | N/A | The source location needed to calculate the nearest appointment locations. | - |
milesLimit | query | string | false | N/A | The maximum number of miles away from the patient’s address that the appointment locations should be. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of appointment locations. | AppointmentLocationsEntities |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Searches all appointment locations for the given HealtheIntent tenant based on primary search criteria of source and distance then based on secondary search criteria of location IDs of the appointments.
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-locations/search', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-locations/search \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"applicationExperienceDomain": "dev.us.healtheintent.com",
"locationId": "26222027",
"name": "Cerner Clinic",
"phone": "0000000000",
"phoneExt": "800",
"street1": "2800 Rock Creek Pkwy",
"street2": "street2",
"street3": "street3",
"street4": "street4",
"city": "Kansas City",
"state": "MO",
"postalCode": "WDR454",
"country": "USA",
"latitude": "12.67",
"longitude": "17.76",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-locations/search?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/appointment-locations/search?offset=0&limit=20"
}
POST /appointment-locations/search
Searches appointment locations for scheduling.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postAppointmentLocationsSearch | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | AppointmentLocationsEntities |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
Create a List of Appointment Locations
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/scheduling-load-appointment-locations', headers: headers, body: {"appointmentLocations":[{"applicationExperienceDomain":"dev.us.healtheintent.com","locationId":"26222027","name":"Cerner Clinic","phone":"0000000000","phoneExt":"800","street1":"2800 Rock Creek Pkwy","street2":"street2","street3":"street3","street4":"street4","city":"Kansas City","state":"MO","postalCode":"WDR454","country":"USA"}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/scheduling-load-appointment-locations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"appointmentLocations":[{"applicationExperienceDomain":"dev.us.healtheintent.com","locationId":"26222027","name":"Cerner Clinic","phone":"0000000000","phoneExt":"800","street1":"2800 Rock Creek Pkwy","street2":"street2","street3":"street3","street4":"street4","city":"Kansas City","state":"MO","postalCode":"WDR454","country":"USA"}]}
Example response
{
"appointmentLocations": [
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"applicationExperienceDomain": "dev.us.healtheintent.com",
"locationId": "26222027",
"name": "Cerner Clinic",
"phone": "0000000000",
"phoneExt": "800",
"street1": "2800 Rock Creek Pkwy",
"street2": "street2",
"street3": "street3",
"street4": "street4",
"city": "Kansas City",
"state": "MO",
"postalCode": "WDR454",
"country": "USA",
"latitude": "12.67",
"longitude": "17.76",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z"
}
]
}
POST /scheduling-load-appointment-locations
Creates a list of appointment locations for a given HealtheIntent tenant ID in bulk and overrides the existing data.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postSchedulingLoadAppointmentLocations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_SchedulingGeoLocation_AppointmentLocation |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Report Configuration
The report configuration endpoints enable tenants to configure the following items:
- Report Definitions: Report definitions enable you to define the attributes of the report. The following attributes define how and when the report is displayed in the portal for the consumer:
- Event set name: Identifies the report.
- Start date: The start date on which reports are displayed in the portal.
- Publish hours: The publishing time delay in hours.
- Statuses: Indicates whether the Unauthenticated, Transcribed, and In-Progress statuses are enabled. If a status is enabled, the reports in the status are displayed in the portal.
- Report Configurations: Report configurations enable configuring the application experience domain for the report definition. This includes storing, updating, and deleting the report definition associated with the application experience domain. One report definition can be associated with multiple application experience domains, but one domain cannot be associated with multiple report definitions.
Retrieve a List of Report Definitions
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/reports/report-definitions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"report": "CARDIOLOGY",
"eventSetName": "Cardiovascular View",
"displayStartDate": "2020-01-20",
"publishDelayHours": 0,
"displayUnauthenticated": "true",
"displayTranscribed": "true",
"displayInProgress": "true"
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions?offset=0&limit=20"
}
GET /reports/report-definitions
Retrieves a list of report definitions.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | ReportDefinitions |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Report Definition
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/reports/report-definitions', headers: headers, body: {"eventSetName":"Cardio Vascular View","displayStartDate":"2020-01-20","publishDelayHours":0,"displayUnauthenticated":"true","displayTranscribed":"true","displayInProgress":"true"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"eventSetName":"Cardio Vascular View","displayStartDate":"2020-01-20","publishDelayHours":0,"displayUnauthenticated":"true","displayTranscribed":"true","displayInProgress":"true"}
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"report": "CARDIOLOGY",
"eventSetName": "Cardiovascular View",
"displayStartDate": "2020-01-20",
"publishDelayHours": 0,
"displayUnauthenticated": "true",
"displayTranscribed": "true",
"displayInProgress": "true"
}
POST /reports/report-definitions
Creates a new report definition.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postReportsReportDefinitions | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_ReportDefinition |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a Report Definition
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/reports/report-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /reports/report-definitions/{reportDefinitionId}
Deletes a specific report definition. A report definition cannot be deleted if it is associated with an application experience domain.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reportDefinitionId | path | string | true | N/A | The unique ID of the report definition associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single Report Definition
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/reports/report-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"report": "CARDIOLOGY",
"eventSetName": "Cardiovascular View",
"displayStartDate": "2020-01-20",
"publishDelayHours": 0,
"displayUnauthenticated": "true",
"displayTranscribed": "true",
"displayInProgress": "true"
}
GET /reports/report-definitions/{reportDefinitionId}
Retrieves a single report definition.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reportDefinitionId | path | string | true | N/A | The unique ID of the report definition associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_ReportDefinition |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a List of Report Configurations
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/reports/report-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z",
"reportDefinitions": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"report": "CARDIOLOGY",
"eventSetName": "Cardiovascular View",
"displayStartDate": "2020-01-20",
"publishDelayHours": 0,
"displayUnauthenticated": "true",
"displayTranscribed": "true",
"displayInProgress": "true"
}
]
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations?offset=0&limit=20"
}
GET /reports/report-configurations
Retrieves a list of report configurations.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
applicationExperienceDomain | query | string | false | N/A | Filters by the domain to which the tenant ID belongs. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | GetReportConfigurations |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Report Configuration
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/reports/report-configurations', headers: headers, body: {"reportDefinitions":[{"reportDefinitionId":"262038ed-c304-4737-93d9-55615b6a1cd5"}],"applicationExperienceDomain":"dev.healtheintent.com"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"reportDefinitions":[{"reportDefinitionId":"262038ed-c304-4737-93d9-55615b6a1cd5"}],"applicationExperienceDomain":"dev.healtheintent.com"}
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z",
"reportDefinitions": [
{
"reportDefinitionId": "262038ed-c304-4737-93d9-55615b6a1cd5"
}
]
}
POST /reports/report-configurations
Creates a new report configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postReportsReportConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PostReportConfiguration |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Update a Report Configuration
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/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"reportDefinitions":[{"reportDefinitionId":"262038ed-c304-4737-93d9-55615b6a1cd5"}],"applicationExperienceDomain":"dev.healtheintent.com"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"reportDefinitions":[{"reportDefinitionId":"262038ed-c304-4737-93d9-55615b6a1cd5"}],"applicationExperienceDomain":"dev.healtheintent.com"}
PUT /reports/report-configurations/{reportConfigurationId}
Updates a specific report configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reportConfigurationId | path | string | true | N/A | The unique ID of the report configuration associated with the HealtheIntent tenant. | - |
body | body | putReportsReportConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Delete a Report Configuration
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/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /reports/report-configurations/{reportConfigurationId}
Deletes a specific report configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reportConfigurationId | path | string | true | N/A | The unique ID of the report configuration associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single Report Configuration
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/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/report-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z",
"reportDefinitions": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"report": "CARDIOLOGY",
"eventSetName": "Cardiovascular View",
"displayStartDate": "2020-01-20",
"publishDelayHours": 0,
"displayUnauthenticated": "true",
"displayTranscribed": "true",
"displayInProgress": "true"
}
]
}
GET /reports/report-configurations/{reportConfigurationId}
Retrieves a specific report configuration.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
reportConfigurationId | path | string | true | N/A | The unique ID of the report configuration associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_GetReportConfiguration |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Reports Policy Text Configuration
The Reports Policy Text Configuration endpoints enable tenants to configure the following items:
- Policy Text Definitions: Policy text definitions enable adding the policies, disclaimer, and other important information related to the reports page that is displayed to the consumer in a specific language and locale. This mainly applies to reports for cardiology, microbiology, pathology, and radiology. This allows tenants to create only one policy text definition for a locale. The locale is the language code, for example,
en-US
. - Policy Text Configurations: Policy text configurations enable the configuration of application experience domains for policy texts. This includes storing, updating, and deleting the policy text definition’s associated with the application experience domain. Associating the policy text with the domain allows the text to be displayed in that domain. One policy text can be associated with multiple application experience domains, but one domain cannot be associated with multiple texts.
Retrieve a List of Reports Policy Texts Definitions
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/reports/policy-text-definitions', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
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/reports/policy-text-definitions?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions?offset=0&limit=20"
}
GET /reports/policy-text-definitions
Retrieves a list of policy text definitions for reports.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of reports policy texts. | PolicyTextDefinitions |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Reports Policy Text Definition
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/reports/policy-text-definitions', headers: headers, body: {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"localeTexts":[{"locale":"en-US","text":"Sample Policy Text."}]}
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"localeTexts": [
{
"locale": "en-US",
"text": "Sample Policy Text."
}
]
}
POST /reports/policy-text-definitions
Creates a new policy text definition for reports.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postReportsPolicyTextDefinitions | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PolicyTextDefinition |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Delete a Reports Policy Text Definition
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/reports/policy-text-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /reports/policy-text-definitions/{policyTextDefinitionId}
Deletes a specific reports policy text definition.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
policyTextDefinitionId | path | string | true | N/A | The unique ID of the policy text associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Deleted | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a Single Reports Policy Text Definition
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/reports/policy-text-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-definitions/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "2bab765b-cbeb-40ef-b557-540ab3841cdf",
"localeTexts": [
{
"locale": "en-US",
"text": "Sample Policy Text."
}
]
}
GET /reports/policy-text-definitions/{policyTextDefinitionId}
Retrieves a single policy text definition for reports.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
policyTextDefinitionId | path | string | true | N/A | The unique ID of the policy text associated with the HealtheIntent tenant. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A single policy text for reports. | PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PolicyTextDefinition |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Retrieve a List of Reports Policy Text Configurations
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/reports/policy-text-configurations', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Accept-Language: [object Object]'
Example response
{
"items": [
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z",
"policyTextDefinition": {
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"localeTexts": [
{
"locale": "en-US",
"text": "Sample Policy Text."
}
]
}
}
],
"totalResults": 1,
"firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations?offset=0&limit=20",
"lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations?offset=0&limit=20"
}
GET /reports/policy-text-configurations
Retrieves a list of policy text configurations for reports.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
applicationExperienceDomain | query | string | false | N/A | Filters by the ID of the tenant’s environment. | - |
Accept-Language | header | string | false | en-US | The locale of the policy text. | - |
offset | query | integer(int32) | false | 0 | The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. | - |
limit | query | integer(int32) | false | 20 | The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | A collection of policy text configurations for reports. | GetPolicyTextConfigurations |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Create a Reports Policy Text Configuration
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/reports/policy-text-configurations', headers: headers, body: {"policyTextDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}
Example response
{
"id": "262038ed-c304-4737-93d9-55615b6a1cd5",
"applicationExperienceDomain": "dev.healtheintent.com",
"createdAt": "2020-01-20T05:40:02.000Z",
"updatedAt": "2020-01-20T05:40:02.000Z",
"policyTextDefinitionId": "262038ed-c304-4737-93d9-55615b6a1ce6"
}
POST /reports/policy-text-configurations
Creates a policy text configuration for reports.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
body | body | postReportsPolicyTextConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | PatientPortalApplicationPublicApi_Entities_V1_ReportsConfig_PostPolicyTextConfiguration |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
Update a Reports Policy Text Configuration
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/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers, body: {"policyTextDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}.to_json )
print JSON.pretty_generate(result)
# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"policyTextDefinitionId":"2b116b34-5ad4-4a3e-8226-80bd580315d9","applicationExperienceDomain":"dev.healtheintent.com"}
PUT /reports/policy-text-configurations/{policyTextConfigurationId}
Updates a policy text configuration for reports. Only the policy text ID can be updated; the application experience domain cannot be.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
policyTextConfigurationId | path | string | true | N/A | The unique ID of the policy text configuration associated with the HealtheIntent tenant. | - |
body | body | putReportsPolicyTextConfigurations | true | N/A | No description | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | Updated | None |
400 | Bad Request | Bad Request | Error |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not Found | Error |
Delete a Reports Policy Text Configuration
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/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/patient-portal-application/v1/reports/policy-text-configurations/2bab765b-cbeb-40ef-b557-540ab3841cdf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
DELETE /reports/policy-text-configurations/{policyTextConfigurationId}
Deletes a policy text configuration for reports.
Parameters
Parameter | In | Type | Required |
---|