NAV Navbar
Logo cerner
Ruby Shell

Data Source API v1

Data sources contribute data to the HealtheIntent platform. Typically, a data source is a system, for example, an electronic health record (EHR) or revenue cycle management (RCM) system; however, payers and other entities also can be data sources. You determine the granularity of data sources based on how you want the data ingestion service to partition the contributed data.

Data ingestion services receive raw data and process it into a state in which other platform services can use it, for example, the longitudinal record services for resources such as allergies and conditions. Each data source uses a single data ingestion service that receives the contributed data, processes it, and publishes it to a data partition. Some data ingestion services can be used to divide the contributed data from a single data source into multiple data partitions. See the Data Partitions resource for more information about data partitions.

Each data source is owned by a single platform tenant and cannot be shared across tenants. After the data ingestion service processes the contributed data and publishes it to a data partition, tenants can share the data partition.

See Data Ingestion for a list of the available data ingestion services.

URL: https://cernerdemo.api.us.healtheintent.com/data-source/v1

Data Sources

A data source is a contributor of data to the HealtheIntent platform. Each contributor must be created as a data source on the platform before it can send data to the platform.

Create a Data Source

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.healtheintent.com/data-source/v1/data-sources', headers: headers)

print JSON.pretty_generate(result)




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

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Cerner Demo",
  "description": "Cerner - Demo EMR",
  "mnemonic": "cerner-demo",
  "tags": [
    "EMR"
  ],
  "systemVendors": [
    {
      "mnemonic": "CERNER_MILLENNIUM",
      "name": "Cerner Millennium"
    }
  ],
  "tenant": {
    "id": "4fd3ce2f-2897-405d-9418-f31d49040de5"
  }
}

POST /data-sources

Creates a data source that is owned by the tenant. A data source’s mnemonic cannot be modified after it is created.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postDataSources true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created DataSource
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Data Sources

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.healtheintent.com/data-source/v1/data-sources', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-sources \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
      "name": "Cerner Demo",
      "description": "Cerner - Demo EMR",
      "mnemonic": "cerner-demo",
      "tags": [
        "EMR"
      ],
      "systemVendors": [
        {
          "mnemonic": "CERNER_MILLENNIUM",
          "name": "Cerner Millennium"
        }
      ],
      "tenant": {
        "id": "4fd3ce2f-2897-405d-9418-f31d49040de5"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /data-sources

Retrieves a list of data sources that the tenant owns.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the retrieved data partitions to those matching this name. Case insensitive and partial name matching are used, meaning that any data partition that contains this value anywhere in the name is retrieved. For example, a value of cross matches both Blue Cross Blue Shield and Rivercross Health EMR. -
id query array[string] false N/A Filters the retrieved data sources to those with one of these IDs. A maximum of 20 IDs can be specified. -
tag query array[string] false N/A Filters the retrieved data sources to those with any of these tags. A maximum of 20 tags can be specified. Case insensitive and partial name matching are used, meaning that any data partition containing this value anywhere in one of its tags is retrieved. -
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 DataSources
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Data Source

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PATCH /data-sources/{dataSourceId}

Updates a data source that the tenant owns.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
body body patchDataSources 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 Data Source

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.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Cerner Demo",
  "description": "Cerner - Demo EMR",
  "mnemonic": "cerner-demo",
  "tags": [
    "EMR"
  ],
  "systemVendors": [
    {
      "mnemonic": "CERNER_MILLENNIUM",
      "name": "Cerner Millennium"
    }
  ],
  "tenant": {
    "id": "4fd3ce2f-2897-405d-9418-f31d49040de5"
  }
}

GET /data-sources/{dataSourceId}

Retrieves a single data source that the tenant owns.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -

Response Statuses

Status Meaning Description Schema
200 OK OK DataSource
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Data Partitions

Data partitions are the logical partitions of data in HealtheIntent for a data source. Most data that is ingested into the platform is transformed until its shape is normalized and its terminology is standardized. After the data is transformed, it is published in data partitions and ready to be used by other platform services, solutions, and applications.

Create a Data Partition

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.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
  "name": "DEMO:EMR",
  "description": "Cerner - Demo EMR",
  "tags": [
    "EMR"
  ],
  "tenant": {
    "id": "4fd3ce2f-2897-405d-9418-f31d49040de5"
  }
}

POST /data-sources/{dataSourceId}/data-partitions

Creates a data partition and associates it with a given data source. The data partition is owned by the data source’s tenant.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
body body postDataSourcesDatasourceidDataPartitions true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created DataPartition
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve Data Partitions by Source

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.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
      "name": "DEMO:EMR",
      "description": "Cerner - Demo EMR",
      "tags": [
        "EMR"
      ],
      "tenant": {
        "id": "4fd3ce2f-2897-405d-9418-f31d49040de5"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /data-sources/{dataSourceId}/data-partitions

Retrieves a list of data partitions that the tenant owns or is authorized to access and that are associated with a given data source.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the retrieved data partitions to those matching this name. Case insensitive and partial name matching are used, meaning that any data partition that contains this value anywhere in the name is retrieved. For example, a value of cross matches both Blue Cross Blue Shield and Rivercross Health EMR. -
id query array[string] false N/A Filters the retrieved data partitions to those with one of these IDs. A maximum of 20 IDs can be specified. -
tag query array[string] false N/A Filters the retrieved data partitions to those with any of these tags. A maximum of 20 tags can be specified. Case insensitive and partial name matching are used, meaning that any data partition containing this value anywhere in one of its tags is retrieved. -
dataSourceId path string true N/A The ID of the data source. -
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 DataPartitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve Data Partitions by 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.healtheintent.com/data-source/v1/data-partitions', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-partitions \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
      "name": "DEMO:EMR",
      "description": "Cerner - Demo EMR",
      "tags": [
        "EMR"
      ],
      "tenant": {
        "id": "4fd3ce2f-2897-405d-9418-f31d49040de5"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /data-partitions

Retrieves a list of data partitions that the tenant owns or is authorized to access.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the retrieved data partitions to those matching this name. Case insensitive and partial name matching are used, meaning that any data partition name that contains this value anywhere in the name is retrieved. For example, a value of cross matches both Blue Cross Blue Shield and Rivercross Health EMR. -
id query array[string] false N/A Filters the retrieved data partitions to those with one of these IDs. A maximum of 20 IDs can be specified. -
tag query array[string] false N/A Filters the retrieved data partitions to those with any of these tags. A maximum of 20 tags can be specified. Case insensitive and partial name matching are used, meaning that any data partition containing this value anywhere in one of its tags is retrieved. -
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 DataPartitions
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Update a Data Partition

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = HTTParty.patch('https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PATCH /data-partitions/{dataPartitionId}

Updates a data partition that the tenant owns.

Parameters

Parameter In Type Required Default Description Accepted Values
dataPartitionId path string true N/A The ID of the data partition. -
body body patchDataPartitions 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 Data Partition

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.healtheintent.com/data-source/v1/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
  "name": "DEMO:EMR",
  "description": "Cerner - Demo EMR",
  "tags": [
    "EMR"
  ],
  "tenant": {
    "id": "4fd3ce2f-2897-405d-9418-f31d49040de5"
  }
}

GET /data-partitions/{dataPartitionId}

Retrieves a single data partition that the tenant owns or is authorized to access.

Parameters

Parameter In Type Required Default Description Accepted Values
dataPartitionId path string true N/A The ID of the data partition. -

Response Statuses

Status Meaning Description Schema
200 OK OK DataPartition
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Authorizations

Data partition authorizations allow tenants to grant read-only access to data partitions to other tenants. Tenants that are authorized to access another tenant’s data partition can retrieve the single data partition and a list of data partitions that includes the other tenant’s partition. For example, if two tenants have a data sharing agreement or if a tenant outsources work to a third party, the tenant can grant access to a data partition instead of the whole tenant.

Create a Data Partition Authorization

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.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/authorizations', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/authorizations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "34bedeec-28ee-4813-87fd-9971d552f52c",
  "tenant": {
    "mnemonic": "cernerdemo-validation"
  }
}

POST /data-sources/{dataSourceId}/data-partitions/{dataPartitionId}/authorizations

Authorizes a tenant to access a data partition.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
dataPartitionId path string true N/A The ID of the data partition. -
body body postDataSourcesDatasourceidDataPartitionsDatapartitionidAuthorizations true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created Authorization
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve Data Partition Authorizations

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.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/authorizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/authorizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "34bedeec-28ee-4813-87fd-9971d552f52c",
      "tenant": {
        "mnemonic": "cernerdemo-validation"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /data-sources/{dataSourceId}/data-partitions/{dataPartitionId}/authorizations

Retrieves the list of authorizations for a data partition.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
dataPartitionId path string true N/A The ID of the data partition. -
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 Authorizations
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Remove a Data Partition Authorization

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.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/authorizations/34bedeec-28ee-4813-87fd-9971d552f52c', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/data-source/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/data-partitions/877307a0-b5f5-4a01-9d4b-9fead6bcf788/authorizations/34bedeec-28ee-4813-87fd-9971d552f52c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /data-sources/{dataSourceId}/data-partitions/{dataPartitionId}/authorizations/{authorizationId}

Revokes a tenant’s access to a data partition.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
dataPartitionId path string true N/A The ID of the data partition. -
authorizationId path string true N/A The ID of the data partition authorization. -

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
409 Conflict Conflict Error

System Vendors

Some data sources are classified further by system vendors, especially EHR and RCM systems such as Cerner Millennium or Soarian Financials.

Retrieve a List of System Vendors

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.healtheintent.com/data-source/v1/system-vendors', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/data-source/v1/system-vendors \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "mnemonic": "CERNER_MILLENNIUM",
      "name": "Cerner Millennium"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /system-vendors

Retrieves a list of the system vendors on the platform.

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

Retrieve a Single System Vendor

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.healtheintent.com/data-source/v1/system-vendors/CERNER', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/data-source/v1/system-vendors/CERNER \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "mnemonic": "CERNER_MILLENNIUM",
      "name": "Cerner Millennium"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /system-vendors/{systemVendorMnemonic}

Retrieves a single system vendor.

Parameters

Parameter In Type Required Default Description Accepted Values
systemVendorMnemonic path string true N/A The mnemonic of the system vendor. -

Response Statuses

Status Meaning Description Schema
200 OK OK SystemVendor
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

SystemVendor

Name Type Required Description Accepted Values
mnemonic string false The mnemonic of the system vendor. -
name string false The name of the system vendor. -

Tenant

Name Type Required Description Accepted Values
id string false The ID of the tenant. -

postDataSources

Name Type Required Description Accepted Values
name string true The name of the data source. -
mnemonic string true The unique human-readable ID of the data source in the owner tenant. -
systemVendors [SystemVendor] false The vendors and product of the source, for example, Cerner Millennium or Soarian Financials. This typically applies only to EHR and RCM source types. -
tags [string] false Tags can be used to group related data sources. -
description string false The description of the data source. -
tenant Tenant false No description -

DataSource

Name Type Required Description Accepted Values
id string false The unique ID of the data source. -
name string false The name of the data source. -
description string false The description of the data source. -
mnemonic string false The unique human-readable ID of the data source in the owner tenant. -
tags [string] false Tags can be used to group related data sources. -
systemVendors [SystemVendor] false The vendors and product of the source, for example, Cerner Millennium or Soarian Financials. This typically applies only to EHR and RCM source types. -
tenant Tenant false No description -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

DataSources

Name Type Required Description Accepted Values
items [DataSource] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

patchDataSources

Name Type Required Description Accepted Values
name string false The name of the data source. -
description string false The description of the data source. -
tags [string] false Tags can be used to group related data sources. -
systemVendors [SystemVendor] false The vendors and product of the source, for example, Cerner Millennium or Soarian Financials. This typically applies only to EHR and RCM source types. -

postDataSourcesDatasourceidDataPartitions

Name Type Required Description Accepted Values
name string true The name of the data partition. -
description string false The description of the data partition. -
tags [string] false Tags can be used to group related data partitions. -
dataSource string false The data source from which the data that produced the data partition was contributed. -

DataPartition

Name Type Required Description Accepted Values
id string false The unique ID of the data partition. -
name string false The name of the data partition. -
description string false The description of the data partition. -
dataSource DataSourceId false The data source from which the data that produced the data partition was contributed. -
tags [string] false Tags can be used to group related data partitions. -
tenant Tenant false No description -

DataSourceId

Name Type Required Description Accepted Values
id string false The ID of the data source. -

DataPartitions

Name Type Required Description Accepted Values
items [DataPartition] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

AuthorizedTenant

Name Type Required Description Accepted Values
mnemonic string true The mnemonic for the tenant. -

postDataSourcesDatasourceidDataPartitionsDatapartitionidAuthorizations

Name Type Required Description Accepted Values
tenant AuthorizedTenant true The tenant that is authorized to access the data partition. -

Authorization

Name Type Required Description Accepted Values
id string true The unique ID of the data partition authorization. -
tenant AuthorizedTenant true The tenant that is authorized to access the data partition. -

Authorizations

Name Type Required Description Accepted Values
items [Authorization] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

SystemVendors

Name Type Required Description Accepted Values
items [SystemVendor] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

patchDataPartitions

Name Type Required Description Accepted Values
name string false The name of the data partition. -
description string false The description of the data partition. -
tags [string] false Tags can be used to group related data partitions. -