Tenant API v1
HealtheIntent Service exposing operations to work with the tenant service.
URL: https://cernerdemo.api.us-1.healtheintent.com/tenant/v1
Tenant
HealtheIntent is a multi-tenant platform, which means that multiple Cerner clients share resources, such as processing and hardware, without that sharing being evident to users. Usually, each client is represented as a single tenant within a given region. Tenants are frequently referenced with a short human-readable mnemonic, which forms part of the base URI for all API calls.
Retrieve a Tenant
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/tenant/v1/tenant', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/tenant/v1/tenant \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"id": "11e8901dafad94f7a9b701d255a00ad0",
"mnemonic": "cernerdemo",
"name": "Cerner Demo",
"timeZone": "America/Chicago",
"defaultLocale": "en-US",
"status": {
"state": "ONBOARDING",
"startedOn": "2018-01-31"
},
"locales": [
"en-US",
"en-GB"
],
"cernerMnemonics": [
"CERN_DEMO"
]
}
GET /tenant
Retrieves the tenant information associated with the mnemonic in the host address.
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieves the tenant information associated with the mnemonic in the host address. | Tenant |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not found | Error |
500 | Internal Server Error | Internal server error | Error |
Retrieve Status Records for a Tenant
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/tenant/v1/tenant/status-records', headers: headers)
print JSON.pretty_generate(result)
# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/tenant/v1/tenant/status-records \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'
Example response
{
"items": [
{
"state": "ONBOARDING",
"startedOn": "2018-01-31"
}
],
"totalResults": 1,
"firstLink": "http://cernerdemo.api.us-1.healtheintent.com/tenant/v1/status-records?offset=0&limit=20",
"lastLink": "http://cernerdemo.api.us-1.healtheintent.com/tenant/v1/status-records?offset=0&limit=20"
}
GET /tenant/status-records
Retrieves a paged list of tenant status records. A tenant is identified by the tenant mnemonic from the domain.
Parameters
Parameter | In | Type | Required | Default | Description | Accepted Values |
---|---|---|---|---|---|---|
orderBy | query | string | false | -startedOn | A comma-separated list of fields by which to sort. | state, -state, startedOn, -startedOn |
offset | query | integer(int32) | false | N/A | Indicates the starting index of the paginated collection. | - |
limit | query | integer(int32) | false | 20 | Indicates the number of results returned in a single page. The value set must be between 1 and 100. | - |
Response Statuses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Retrieves a paged list of tenant status records. A tenant is identified by the tenant mnemonic from the domain. | StatusRecords |
401 | Unauthorized | Unauthorized | Error |
403 | Forbidden | Forbidden | Error |
404 | Not Found | Not found | Error |
500 | Internal Server Error | Internal server error | Error |
Schema Definitions
Tenant
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
id | string | true | The unique identifier of this tenant. | - |
mnemonic | string | true | The unique mnemonic of this tenant. | - |
name | string | true | The unique name of this tenant. | - |
timeZone | string | true | This value matches a valid time zone in the IANA database (http://www.iana.org/time-zones). | - |
defaultLocale | string | true | The locale that will be used when an alternative locale is not specified. | - |
status | StatusRecord | true | No description | - |
locales | [string] | true | Each locale matches the ISO 639-1 specification which uses a two-letter code to identify the language and is separated by hyphens, like en-US. |
- |
cernerMnemonics | [string] | false | A list of Cerner client mnemonics associated with the HealtheIntent tenant. | - |
StatusRecord
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
state | string | true | The status of a tenant. The values will be in uppercase and separated by underscores. The started on date for a status must be on or after all previous status started on dates. Tenants in the INACTIVE state will not be returned. The following are the meanings of each possible state: - ONBOARDING - The Tenant is being onboarded and has no active solutions. - INTERNALLY_ACTIVE - The Tenant has gone internally active with a solution. - READY - The Tenant is in System Readiness. - ACTIVE - The Tenant is publicly active in HealtheIntent. - INACTIVE - This Tenant is no longer active in HealtheIntent and must be reactivated to be used again. | ONBOARDING, ACTIVE, INTERNALLY_ACTIVE, READY, INACTIVE |
startedOn | string(date) | false | The start date of the recorded state in YYYY-MM-DD format. This must be on or later than the previous startedOn date for a tenant. | - |
Error
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
code | integer(int32) | true | Http response status code representing the error. | - |
message | string | true | Human readable description of the error. | - |
errorDetails | [ErrorDetail] | false | List of additional error details. | - |
ErrorDetail
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
domain | string | false | A subsystem or context where an error occurred. | - |
reason | string | false | Codified value representing the specific error resulting in the current error status. | - |
message | string | false | Human readable description of an error. | - |
locationType | string | false | Location or type of the field that caused an error. | query, header, path, formData, body |
location | string | false | Name of the field that caused an error. | - |
StatusRecords
Name | Type | Required | Description | Accepted Values |
---|---|---|---|---|
items | [StatusRecord] | false | No description | - |
totalResults | integer(int32) | false | The total number of results for the specified parameters. | - |
firstLink | string | false | The first page of results. | - |
lastLink | string | false | The last page of results. | - |
prevLink | string | false | The previous page of results. | - |
nextLink | string | false | The next page of results. | - |