NAV
Ruby Shell

Universal Data Ingestion API v1

The Universal Data Ingestion (UDI) service is the data ingestion service designed to meet the majority of the data ingestion use cases for continuously streaming data in low latency time frames for the Oracle Health Data Intelligence platform.

URL: https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1

Data Sources

Data sources are UDI-specific buckets into which data contributors upload data files. Generally, a data source identifies a source system from which data is ingested; however, multiple data sources can receive data from the same source system. Each data source must have a name, and Cerner recommends that the name clearly differentiates the data source from others. Each data source is owned by a single tenant and cannot be shared directly with other tenants. A data source must be specified when a file is uploaded.

Add 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-1.healtheintent.com/universal-data-ingestion/v1/data-sources', headers: headers, body: {"name":"Cerner Demo","description":"Cerner - Demo EMR","tags":[{"key":"Use","value":"Production"},{"key":"Development"}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/data-sources \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cerner Demo","description":"Cerner - Demo EMR","tags":[{"key":"Use","value":"Production"},{"key":"Development"}]}

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Cerner Demo",
  "description": "Cerner - Demo EMR",
  "tags": [
    {
      "key": "Use",
      "value": "Production"
    },
    {
      "key": "Development"
    }
  ],
  "createdAt": "2020-05-03T11:32:57.041Z",
  "updatedAt": "2020-05-06T10:01:21.025Z"
}

POST /data-sources

Creates a data source owned by the tenant in the UDI service.

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

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/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",
      "tags": [
        {
          "key": "Use",
          "value": "Production"
        },
        {
          "key": "Development"
        }
      ],
      "createdAt": "2020-05-03T11:32:57.041Z",
      "updatedAt": "2020-05-06T10:01:21.025Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /data-sources

Retrieves all the data sources owned by the tenant in the UDI service.

Parameters

Parameter In Type Required Default Description Accepted Values
id query array[string] false N/A Filters the data sources to only those with any of the specified IDs. A maximum of 20 IDs can be specified in a single request. -
name query string false N/A Filters the data sources to only those with the specified name. Case insensitive and partial string matching are supported, which means that any data source with a name that contains the specified characters regardless of case is returned. For example, a value of cross returns both Blue Cross Blue Shield and Rivercross Health EMR. -
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-1.healtheintent.com/universal-data-ingestion/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c', headers: headers, body: {"name":"Cerner Demo","description":"Cerner - Demo EMR","tags":[{"key":"Use","value":"Production"},{"key":"Development"}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X PATCH https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Cerner Demo","description":"Cerner - Demo EMR","tags":[{"key":"Use","value":"Production"},{"key":"Development"}]}

PATCH /data-sources/{dataSourceId}

Updates the specified data source owned by the tenant in the UDI service. A data source can be updated by only the tenant who owns it.

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-1.healtheintent.com/universal-data-ingestion/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-1.healtheintent.com/universal-data-ingestion/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",
  "tags": [
    {
      "key": "Use",
      "value": "Production"
    },
    {
      "key": "Development"
    }
  ],
  "createdAt": "2020-05-03T11:32:57.041Z",
  "updatedAt": "2020-05-06T10:01:21.025Z"
}

GET /data-sources/{dataSourceId}

Retrieves the specified data source owned by the tenant in the UDI service. A data source can be retrieved by only the tenant who owns it.

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 UniversalDataIngestionPublicApi_V1_DataSource
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Contributed Records

Contributed records are records that are sent, or uploaded, to the platform. Each contributed record must be identified by a data source, record type set, record type, and record type schema.

Upload a Contributed Record or Records

Example Request:




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

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'UDI-RecordStreamId' => {
  "type": "string"
},
  'UDI-RecordTypeSchemaId' => {
  "type": "string"
}
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/contributed-records', headers: headers, body: {"records":[{"recordKeyFields":[{"name":"field1Name","value":"field1Value"},{"name":"field2Name","value":"field2Value"}],"operation":"WRITE","version":123,"value":"bytes..."},{"recordKeyFields":[{"name":"field1Name","value":"field1Value"},{"name":"field2Name","value":"field2Value"}],"operation":"DELETE","version":124}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/contributed-records \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \ \
-H 'UDI-RecordStreamId: [object Object]' \ \
-H 'UDI-RecordTypeSchemaId: [object Object]' \
-d {"records":[{"recordKeyFields":[{"name":"field1Name","value":"field1Value"},{"name":"field2Name","value":"field2Value"}],"operation":"WRITE","version":123,"value":"bytes..."},{"recordKeyFields":[{"name":"field1Name","value":"field1Value"},{"name":"field2Name","value":"field2Value"}],"operation":"DELETE","version":124}]}

POST /data-sources/{dataSourceId}/contributed-records

Uploads a contributed record or records.

Parameters

Parameter In Type Required Default Description Accepted Values
UDI-RecordStreamId header string true N/A The ID of the record stream. -
UDI-RecordTypeSchemaId header string true N/A The ID of the record type schema. -
dataSourceId path string true N/A The ID of the data source. -
body body postDataSourcesDatasourceidContributedRecords true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created UniversalDataIngestionPublicApi_V1_ContributedRecordUploadResponse
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
413 Payload Too Large Payload Too Large Error

Record Streams

A record stream is a stream of records that is received and loaded into a specific data source. Record streams allow records to be separated in a data source. The processing of contributed records into partition records is configured at the record stream level. For example, when you configure the processing of each data set in a partition, you can select the record stream to be processed for each data set.

Add a Record Stream

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/universal-data-ingestion/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-streams', headers: headers, body: {"name":"Encounter Stream","description":"Encounter Stream Description","recordTypeSetId":"d7abf786-e051-4627-80e9-1f7db9a04788","recordTypeId":"d7abf786-e051-4627-80e9-1f7db9a04788"}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-streams \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Encounter Stream","description":"Encounter Stream Description","recordTypeSetId":"d7abf786-e051-4627-80e9-1f7db9a04788","recordTypeId":"d7abf786-e051-4627-80e9-1f7db9a04788"}

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Encounter Stream",
  "description": "Encounter Stream Description",
  "createdAt": "2020-02-26T20:48:36.650Z",
  "recordTypeSet": {
    "id": "ctc4117a-4f2f-4e39-9d60-76563fa5b83e"
  },
  "recordType": {
    "id": "ctc4117a-4f2f-4e39-9d60-76563fa5b83e"
  }
}

POST /data-sources/{dataSourceId}/record-streams

Creates a record stream for the specified tenant and data source.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created RecordStream
400 Bad Request Bad Request. The following reasons may be returned:
- dataSourceId is empty
- name is missing
- name is empty
- invalidField - name - name is too long (maximum is 191 characters)
- invalidField - name - name must not contain wildcard percent (%) or underscore (_) characters
- invalidField - description - description is too long (maximum is 1000 characters)
- recordTypeSetId is missing
- recordTypeSetId is empty
- recordTypeId is missing
- recordTypeId is empty		 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reasons may be returned:
- notFound - Record type set [record type set ID] not found
- notFound - Record type [record type ID] not found
- notFound - No universal data source found for tenant: [tenant ID] and dataSourceId: [data source ID]		 Error

Retrieve a List of Record Streams

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/universal-data-ingestion/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-streams', headers: headers)

print JSON.pretty_generate(result)



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

Example response

{
  "items": [
    {
      "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
      "name": "Encounter Stream",
      "description": "Encounter Stream Description",
      "createdAt": "2020-02-26T20:48:36.650Z",
      "recordTypeSet": {
        "id": "ctc4117a-4f2f-4e39-9d60-76563fa5b83e"
      },
      "recordType": {
        "id": "ctc4117a-4f2f-4e39-9d60-76563fa5b83e"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /data-sources/{dataSourceId}/record-streams

Retrieves all the record streams for the specified tenant and data source

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
orderBy query string false -createdAt A comma-separated list of fields by which to sort. -createdAt, createdAt, name, -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 OK RecordStreams
400 Bad Request Bad Request. The following reasons may be returned:
- dataSourceId is empty
- offset is invalid
- limit does not have a valid value		 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reason may be returned:
- notFound - No universal data source found for tenant: [tenant ID] and dataSourceId: [data source ID]		 Error

Retrieve a Single Record Stream

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/universal-data-ingestion/v1/data-sources/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-streams/c5d5f79c-72b3-43c6-91ec-b8692700311c', headers: headers)

print JSON.pretty_generate(result)



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

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Encounter Stream",
  "description": "Encounter Stream Description",
  "createdAt": "2020-02-26T20:48:36.650Z",
  "recordTypeSet": {
    "id": "ctc4117a-4f2f-4e39-9d60-76563fa5b83e"
  },
  "recordType": {
    "id": "ctc4117a-4f2f-4e39-9d60-76563fa5b83e"
  }
}

GET /data-sources/{dataSourceId}/record-streams/{recordStreamId}

Retrieves the specified record stream owned by the specified tenant in the UDI service. A record stream can be retrieved by only the tenant who owns it.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK OK RecordStream
400 Bad Request Bad Request. The following reasons may be returned:dataSourceId is empty Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reasons may be returned:
- notFound - Record Stream [record stream ID] for tenantId: [tenant ID] and dataSourceId: [data source ID] not found
- notFound - No universal data source found for tenant: [tenant ID] and dataSourceId: [data source ID]		 Error

Record Type Sets

Record type sets group record types together, for example, record types related to a Centers for Medicare & Medicaid Services (CMS) Claims Line Feed (CCLF). Each record type set is specific to a tenant.

Add a Record Type Set

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/universal-data-ingestion/v1/record-type-sets', headers: headers, body: {"name":"Soarian Financials","mnemonic":"soarian-financials","description":"Soarian Financials from Cerner Demo"}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/record-type-sets \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Soarian Financials","mnemonic":"soarian-financials","description":"Soarian Financials from Cerner Demo"}

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Soarian Financials",
  "mnemonic":"soarian-financials",
  "description": "Soarian Financials from Cerner Demo",
  "createdAt": "2020-05-03T11:32:57.041Z"
}

POST /record-type-sets

Creates a record type set owned by the specified tenant in the UDI service.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created RecordTypeSet
400 Bad Request Bad Request. The following reasons may be returned:
- name is missing
- name is empty
- invalidField - name is too long (maximum is 191 characters)
- invalidField - name must not contain wildcard percent (%) or underscore (_) characters
- mnemonic is missing
- mnemonic is empty
- invalidField - mnemonic is too long (maximum is 30 characters)
- invalidField - mnemonic must not contain wildcard percent (%) or underscore (_) characters
- invalidField - description is too long (maximum is 1000 characters)		 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Record Type Sets

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/universal-data-ingestion/v1/record-type-sets', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/record-type-sets \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
      "name": "Soarian Financials",
      "mnemonic":"soarian-financials",
      "description": "Soarian Financials from Cerner Demo",
      "createdAt": "2020-05-03T11:32:57.041Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /record-type-sets

Retrieves all the record type sets owned by the specified tenant in the UDI service.

Parameters

Parameter In Type Required Default Description Accepted Values
name query string false N/A Filters the record type sets to only those with the specified name. Case insensitive and partial string matching are supported, which means that any record type set with a name that contains the specified characters regardless of case is returned. For example, a value of cross returns both Blue Cross Blue Shield and Rivercross Health EMR. Must not contain wildcard percent (%) or underscore (_) characters -
mnemonic query string false N/A Filters the retrieved record type sets to those with a mnemonic exactly matching this mnemonic. -
orderBy query string false -createdAt A comma-separated list of fields by which to sort. -createdAt, createdAt, name, -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 OK RecordTypeSets
400 Bad Request Bad Request. The following reasons may be returned:
- Name is empty
- invalidQueryParameter - limit query parameter cannot contain wildcard character _
- invalidQueryParameter - limit query parameter cannot contain wildcard character %
- offset is invalid
- limit does not have a valid value		 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Record Type Set

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/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c', headers: headers)

print JSON.pretty_generate(result)



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

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Soarian Financials",
  "mnemonic":"soarian-financials",
  "description": "Soarian Financials from Cerner Demo",
  "createdAt": "2020-05-03T11:32:57.041Z"
}

GET /record-type-sets/{recordTypeSetId}

Retrieves the specified record type set owned by the specified tenant in the UDI service. A record type set can be retrieved by only the tenant who owns it.

Parameters

Parameter In Type Required Default Description Accepted Values
recordTypeSetId path string true N/A The ID of the record type set. -

Response Statuses

Status Meaning Description Schema
200 OK OK RecordTypeSet
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reason may be returned: notFound - Record type set [record type set ID] not found Error

Record Types

Each record type set has one to many record types. Each of these identify an object, such as a database table.

Add a Record 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/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types', headers: headers, body: {"name":"Encounter","nmemonic":"encounter","description":"Encounter","recordKeyFieldNames":["field1Name","field2Name"]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Encounter","nmemonic":"encounter","description":"Encounter","recordKeyFieldNames":["field1Name","field2Name"]}

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Encounter",
  "mnemonic": "encounter",
  "description": "Encounter",
  "recordKeyFieldNames": [
    "field1Name",
    "field2Name"
  ],
  "createdAt": "2020-02-26T20:48:36.650Z"
}

POST /record-type-sets/{recordTypeSetId}/record-types

Creates a record type for a record type set owned by the specified tenant in the UDI service.

Parameters

Parameter In Type Required Default Description Accepted Values
recordTypeSetId path string true N/A The ID of the record type set. -
body body postRecordTypeSetsRecordtypesetidRecordTypes true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created RecordType
400 Bad Request Bad Request. The following reasons may be returned:
- recordTypeSetId is empty
- name is missing
- name is empty
- invalidField - name is too long (maximum is 191 characters)
- invalidField - name must not contain wildcard percent (%) or underscore (_) characters
- mnemonic is missing
- mnemonic is empty
- invalidField - mnemonic is too long (maximum is 30 characters)
- invalidField - mnemonic must not contain wildcard percent (%) or underscore (_) characters
- invalidField - description is too long (maximum is 1000 characters)
- recordKeyFieldNames is missing
- recordKeyFieldNames is empty		 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reason may be returned: notFound - Record type set [record type set ID] not found Error

Retrieve a List of Record 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/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types', headers: headers)

print JSON.pretty_generate(result)



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

Example response

{
  "items": [
    {
      "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
      "name": "Encounter",
      "mnemonic": "encounter",
      "description": "Encounter",
      "recordKeyFieldNames": [
        "field1Name",
        "field2Name"
      ],
      "createdAt": "2020-02-26T20:48:36.650Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /record-type-sets/{recordTypeSetId}/record-types

Retrieves all the record types for the specified tenant and record type set.

Parameters

Parameter In Type Required Default Description Accepted Values
recordTypeSetId path string true N/A The ID of the record type set. -
name query string false N/A Filters the record types to only those with the specified name. Case insensitive and partial string matching are supported, which means that any record type set with a name that contains the specified characters regardless of case is returned. For example, a value of cross returns both Blue Cross Blue Shield and Rivercross Health EMR. Must not contain wildcard percent (%) or underscore (_) characters -
mnemonic query string false N/A The mnemonic of the record type to use as a filter. -
orderBy query string false -createdAt A comma-separated list of fields by which to sort. -createdAt, createdAt, name, -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 OK RecordTypes
400 Bad Request Bad Request. The following reasons may be returned:
- recordTypeSetId is empty
- name is empty
- invalidQueryParameter - limit query parameter cannot contain wildcard character _
- invalidQueryParameter - limit query parameter cannot contain wildcard character %
- offset is invalid
- limit does not have a valid value		 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reason may be returned: notFound - Record type set [record type set ID] not found Error

Retrieve a Single Record 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/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types/c5d5f79c-72b3-43c6-91ec-b8692700311c', headers: headers)

print JSON.pretty_generate(result)



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

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Encounter",
  "mnemonic": "encounter",
  "description": "Encounter",
  "recordKeyFieldNames": [
    "field1Name",
    "field2Name"
  ],
  "createdAt": "2020-02-26T20:48:36.650Z"
}

GET /record-type-sets/{recordTypeSetId}/record-types/{recordTypeId}

Retrieves the specified record type owned by the specified tenant in the UDI service. A record type can be retrieved by only the tenant who owns it.

Parameters

Parameter In Type Required Default Description Accepted Values
recordTypeSetId path string true N/A The ID of the record type set. -
recordTypeId path integer(int32) true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK OK RecordType
400 Bad Request Bad Request. The following reason may be returned: recordTypeSetId is empty Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reasons may be returned:
- notFound - Record type set [record type set ID] not found
- notFound - Record type [record type ID] not found		 Error

Record Type Schemas

Each record type has one to many schemas that describe the specific structure of contributed records of the record type. A record type can have multiple schemas, which allows schemas to evolve over time. Each time a new schema is added to a record type, it must be compatible (passive) with the previous schema. All contributed records are checked for conformance to a specific record type schema.

Add a Record Type Schema

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/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types/c5d5f79c-72b3-43c6-91ec-b8692700311c/schemas', headers: headers, body: {"name":"Encounter V1","description":"Encounter Version One","schema":"eyJ0eXBlIiA6ICJvYmplY3QiLCJwcm9wZXJ0aWVzIiA6IHsiYWxsZXJneSIgOiB7IiRyZWYiIDogIiMvZGVmaW5pdGlvbnMvQWxsZXJneSIgfSB9LCJyZXF1aXJlZCIgOiBbImFsbGVyZ3kiXSwiYWRkaXRpb25hbFByb3BlcnRpZXMiIDogZmFsc2UsImRlZmluaXRpb25zIiA6IHsiQWxsZXJneSIgOiB7InR5cGUiIDogIm9iamVjdCIsInByb3BlcnRpZXMiIDogeyJhbGxlcmd5aWVuIiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInN0YTNuIiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInBhdGllbnRpZW4iIDogeyJ0eXBlIiA6ICJzdHJpbmcifSwiYWxsZXJneXR5cGUiIDogeyJ0eXBlIiA6ICJzdHJpbmcifSwiYWxsZXJneXJlYWN0YW50IiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInZpc3RhZWRpdGRhdGUiIDogeyJ0eXBlIiA6ICJzdHJpbmcifX0sImFkZGl0aW9uYWxQcm9wZXJ0aWVzIjogZmFsc2UsInJlcXVpcmVkIiA6IFsiYWxsZXJneWllbiIsInN0YTNuIiwidmlzdGFlZGl0ZGF0ZSJdfX19"}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types/c5d5f79c-72b3-43c6-91ec-b8692700311c/schemas \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Encounter V1","description":"Encounter Version One","schema":"eyJ0eXBlIiA6ICJvYmplY3QiLCJwcm9wZXJ0aWVzIiA6IHsiYWxsZXJneSIgOiB7IiRyZWYiIDogIiMvZGVmaW5pdGlvbnMvQWxsZXJneSIgfSB9LCJyZXF1aXJlZCIgOiBbImFsbGVyZ3kiXSwiYWRkaXRpb25hbFByb3BlcnRpZXMiIDogZmFsc2UsImRlZmluaXRpb25zIiA6IHsiQWxsZXJneSIgOiB7InR5cGUiIDogIm9iamVjdCIsInByb3BlcnRpZXMiIDogeyJhbGxlcmd5aWVuIiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInN0YTNuIiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInBhdGllbnRpZW4iIDogeyJ0eXBlIiA6ICJzdHJpbmcifSwiYWxsZXJneXR5cGUiIDogeyJ0eXBlIiA6ICJzdHJpbmcifSwiYWxsZXJneXJlYWN0YW50IiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInZpc3RhZWRpdGRhdGUiIDogeyJ0eXBlIiA6ICJzdHJpbmcifX0sImFkZGl0aW9uYWxQcm9wZXJ0aWVzIjogZmFsc2UsInJlcXVpcmVkIiA6IFsiYWxsZXJneWllbiIsInN0YTNuIiwidmlzdGFlZGl0ZGF0ZSJdfX19"}

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Encounter V1",
  "description": "Encounter Version One",
  "schema": "eyJ0eXBlIiA6ICJvYmplY3QiLCJwcm9wZXJ0aWVzIiA6IHsiYWxsZXJneSIgOiB7IiRyZWYiIDogIiMvZGVmaW5pdGlvbnMvQWxsZXJneSIgfSB9LCJyZXF1aXJlZCIgOiBbImFsbGVyZ3kiXSwiYWRkaXRpb25hbFByb3BlcnRpZXMiIDogZmFsc2UsImRlZmluaXRpb25zIiA6IHsiQWxsZXJneSIgOiB7InR5cGUiIDogIm9iamVjdCIsInByb3BlcnRpZXMiIDogeyJhbGxlcmd5aWVuIiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInN0YTNuIiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInBhdGllbnRpZW4iIDogeyJ0eXBlIiA6ICJzdHJpbmcifSwiYWxsZXJneXR5cGUiIDogeyJ0eXBlIiA6ICJzdHJpbmcifSwiYWxsZXJneXJlYWN0YW50IiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInZpc3RhZWRpdGRhdGUiIDogeyJ0eXBlIiA6ICJzdHJpbmcifX0sImFkZGl0aW9uYWxQcm9wZXJ0aWVzIjogZmFsc2UsInJlcXVpcmVkIiA6IFsiYWxsZXJneWllbiIsInN0YTNuIiwidmlzdGFlZGl0ZGF0ZSJdfX19",
  "createdAt": "2020-02-26T20:48:36.650Z"
}

POST /record-type-sets/{recordTypeSetId}/record-types/{recordTypeId}/schemas

Creates a record type schema for the specified record type.

Parameters

Parameter In Type Required Default Description Accepted Values
recordTypeSetId path string true N/A The ID of the record type set. -
recordTypeId path string true N/A The ID of the record type. -
body body postRecordTypeSetsRecordtypesetidRecordTypesRecordtypeidSchemas true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created RecordTypeSchema
400 Bad Request Bad Request. The following reasons may be returned:
- recordTypeSetId is empty
- recordTypeId is empty
- Name is missing
- name is empty
- Name is too long (maximum is 191 characters) - invalidField
- invalidField
- invalidField - description is too long (maximum is 1000 characters)
- Schema is missing
- schema is empty
- Error Decoding Base64 Schema - invalidSchema
- Record key field(s) [field or fields] missing in required array - missingRecordKeyField
- Required property [property] not found in the provided schema - missingRequiredFields		 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reasons may be returned:
- Record type set [record type set ID] not found
- Record type [record type ID] not found		 Error

Retrieve a List of Record Type Schemas

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/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types/c5d5f79c-72b3-43c6-91ec-b8692700311c/schemas', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types/c5d5f79c-72b3-43c6-91ec-b8692700311c/schemas \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
      "name": "Encounter V1",
      "description": "Encounter Version One",
      "createdAt": "2020-02-26T20:48:36.650Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/example/v1/examples?offset=0&limit=20"
}

GET /record-type-sets/{recordTypeSetId}/record-types/{recordTypeId}/schemas

Retrieves all the record type schemas for the specified record type

Parameters

Parameter In Type Required Default Description Accepted Values
recordTypeSetId path string true N/A The ID of the record type set. -
recordTypeId path string true N/A The ID of the record type. -
orderBy query string false -createdAt A comma-separated list of fields by which to sort. -createdAt, createdAt, name, -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 OK RecordTypeSchemaGetAlls
400 Bad Request Bad Request. The following reasons may be returned:
- recordTypeSetId is empty
- recordTypeId is empty
- Offset is invalid
- Limit does not have a valid value		 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reasons may be returned:
- Record type set [record type set ID] not found - notFound
- Record type [record type ID] not found - notFound		 Error

Retrieve a Single Record Type Schema

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/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types/c5d5f79c-72b3-43c6-91ec-b8692700311c/schemas/c5d5f79c-72b3-43c6-91ec-b8692700311c', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/universal-data-ingestion/v1/record-type-sets/c5d5f79c-72b3-43c6-91ec-b8692700311c/record-types/c5d5f79c-72b3-43c6-91ec-b8692700311c/schemas/c5d5f79c-72b3-43c6-91ec-b8692700311c \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "c5d5f79c-72b3-43c6-91ec-b8692700311c",
  "name": "Encounter V1",
  "description": "Encounter Version One",
  "schema": "eyJ0eXBlIiA6ICJvYmplY3QiLCJwcm9wZXJ0aWVzIiA6IHsiYWxsZXJneSIgOiB7IiRyZWYiIDogIiMvZGVmaW5pdGlvbnMvQWxsZXJneSIgfSB9LCJyZXF1aXJlZCIgOiBbImFsbGVyZ3kiXSwiYWRkaXRpb25hbFByb3BlcnRpZXMiIDogZmFsc2UsImRlZmluaXRpb25zIiA6IHsiQWxsZXJneSIgOiB7InR5cGUiIDogIm9iamVjdCIsInByb3BlcnRpZXMiIDogeyJhbGxlcmd5aWVuIiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInN0YTNuIiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInBhdGllbnRpZW4iIDogeyJ0eXBlIiA6ICJzdHJpbmcifSwiYWxsZXJneXR5cGUiIDogeyJ0eXBlIiA6ICJzdHJpbmcifSwiYWxsZXJneXJlYWN0YW50IiA6IHsidHlwZSIgOiAic3RyaW5nIn0sInZpc3RhZWRpdGRhdGUiIDogeyJ0eXBlIiA6ICJzdHJpbmcifX0sImFkZGl0aW9uYWxQcm9wZXJ0aWVzIjogZmFsc2UsInJlcXVpcmVkIiA6IFsiYWxsZXJneWllbiIsInN0YTNuIiwidmlzdGFlZGl0ZGF0ZSJdfX19",
  "createdAt": "2020-02-26T20:48:36.650Z"
}

GET /record-type-sets/{recordTypeSetId}/record-types/{recordTypeId}/schemas/{recordTypeSchemaId}

Retrieve the specified record type schema.

Parameters

Parameter In Type Required Default Description Accepted Values
recordTypeSetId path string true N/A The ID of the record type set. -
recordTypeId path string true N/A The ID of the record type. -
recordTypeSchemaId path integer(int32) true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK OK RecordTypeSchema
400 Bad Request Bad Request. The following reasons may be returned:
- recordTypeSetId is empty
- recordTypeId is empty
- Offset is invalid
- Limit does not have a valid value		 Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found. The following reasons may be returned:
- Record type set [record type set ID] not found
- Record type [record type ID] not found
- Record type schema [record type schema ID] not found		 Error

Schema Definitions

postDataSources

Name Type Required Description Accepted Values
name string true The name of the data source. -
description string false The description of the data source. A description can give more details about the source and the data contributed from it. -
tags [object] false Tags allow owners to add metadata to a data source and can be used to indicate the meaning, purpose, or more precise ownership of the data source. Tags are optional but can be used to organize data sources. The data source owner controls the use of tags. A tag consists of a key and an optional value. The key field indicates the intended use of the tag (for example Use to indicate how the data from the data source is intended to be used), and the optional value field indicates the specific instance of the intended use (for example, Production to indicate that the data is intended to be used in a production environment). -
» key string false The intended use of the tag. The key must be unique in a given resource. The maximum length is 128 Unicode characters, and the minimum is 1. -
» value string false The optional, specific instance of the use of the tag. The maximum length is 256 Unicode characters, and the minimum is 0. -

UniversalDataIngestionPublicApi_V1_DataSource

Name Type Required Description Accepted Values
id string true The unique ID of the data source. -
name string true The name of the data source. -
description string false The description of the data source. A description can give more details about the source and the data contributed from it. -
tags [UniversalDataIngestionPublicApi_V1_Tag] false Tags allow owners to add metadata to a data source and can be used to indicate the meaning, purpose, or more precise ownership of the data source. Tags are optional but can be used to organize data sources. The data source owner controls the use of tags. A tag consists of a key and an optional value. The key field indicates the intended use of the tag (for example Use to indicate how the data from the data source is intended to be used), and the optional value field indicates the specific instance of the intended use (for example, Production to indicate that the data is intended to be used in a production environment). -
createdAt string true The date and time when the data source was created, in ISO YYYY-MM-DDThh:mm:ss.SSSZ format. -
updatedAt string true The date and time when the data source was updated, in ISO YYYY-MM-DDThh:mm:ss.SSSZ format. -

UniversalDataIngestionPublicApi_V1_Tag

Name Type Required Description Accepted Values
key string true The intended use of the tag. The key must be unique in a given resource. The maximum length is 128 Unicode characters, and the minimum is 1. -
value string false The optional, specific instance of the use of the tag. The maximum length is 256 Unicode characters, and the minimum is 0. -

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 [UniversalDataIngestionPublicApi_V1_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. A description can give more details about the source and the data contributed from it. -
tags [object] false Tags allow owners to add metadata to a data source and can be used to indicate the meaning, purpose, or more precise ownership of the data source. Tags are optional but can be used to organize data sources. The data source owner controls the use of tags. A tag consists of a key and an optional value. The key field indicates the intended use of the tag (for example Use to indicate how the data from the data source is intended to be used), and the optional value field indicates the specific instance of the intended use (for example, Production to indicate that the data is intended to be used in a production environment). -
» key string false The intended use of the tag. The key must be unique in a given resource. The maximum length is 128 Unicode characters, and the minimum is 1. -
» value string false The optional, specific instance of the use of the tag. The maximum length is 256 Unicode characters, and the minimum is 0. -

UniversalDataIngestionPublicApi_V1_ContributedRecordKeyField

Name Type Required Description Accepted Values
name string true The name of the contributed record key fields. -
value string true The value of the contributed record key fields. -

postDataSourcesDatasourceidContributedRecords

Name Type Required Description Accepted Values
records [object] false The list of records to be uploaded. -
» operation string true The operation performed for the contributed record. WRITE, DELETE
» version integer(int32) true The most recent version of the contributed record. -
» value string true The Base64-encoded representation of the JSON contributed record. -
» recordKeyFields [UniversalDataIngestionPublicApi_V1_ContributedRecordKeyField] true A list of one or more fields that make up the record’s key, in accordance with the record key fields defined for the record type of the specified record stream. Each field contains the field name and field value. -

UniversalDataIngestionPublicApi_V1_ContributedRecordUploadResponse

Name Type Required Description Accepted Values
recordCount string true The number of records uploaded. -

postDataSourcesDatasourceidRecordStreams

Name Type Required Description Accepted Values
name string true The name of the record stream. Cerner recommends that the name be unique in a data source. Must not contain wildcard percent (%) or underscore (_) characters characters. -
description string false The description of the record stream. -
recordTypeSetId string true The ID of the associated record type set. -
recordTypeId string true The ID of the associated record type. -

RecordStream

Name Type Required Description Accepted Values
id string false The ID of the record stream. -
name string false The name of the record stream. Cerner recommends that the name be unique in a data source. Must not contain wildcard percent (%) or underscore (_) characters characters. -
description string false The description of the record stream. -
createdAt string(date-time) false The date and time when the record stream was created, in ISO YYYY-MM-DDThh:mm:ss.SSSZ format. -
recordTypeSet Id false The ID of the associated record type set. -
recordType Id false The ID of the associated record type. -

Id

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

RecordStreams

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

postRecordTypeSets

Name Type Required Description Accepted Values
name string true The name of the record type set. Cerner recommends that the name be unique in a tenant. Must not contain wildcard percent (%) or underscore (_) characters characters. -
mnemonic string true The mnemonic for the record type set. Must not contain wildcard percent (%), space () or underscore (_) characters. Must be under 30 characters. -
description string false The description of the record type set. -

RecordTypeSet

Name Type Required Description Accepted Values
id string true The ID of the record type set. -
name string false The name of the record type set. Cerner recommends that the name be unique in a tenant. Must not contain wildcard percent (%) or underscore (_) characters characters. -
mnemonic string true The mnemonic for the record type set. Must not contain wildcard percent (%), space () or underscore (_) characters. Must be under 30 characters. -
description string false The description of the record type set. -
createdAt string true The date and time when the record type set was created, in ISO YYYY-MM-DDThh:mm:ss.SSSZ format. -

RecordTypeSets

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

postRecordTypeSetsRecordtypesetidRecordTypes

Name Type Required Description Accepted Values
name string true The name of the record type. Cerner recommends that the name be unique in a record type. Must not contain wildcard percent (%) or underscore (_) characters characters. -
mnemonic string true The mnemonic for the record type set. Must not contain wildcard percent (%), space () or underscore (_) characters. Must be under 30 characters. -
description string false The description of the record type. -
recordKeyFieldNames [string] true A list of one or more fields that make up the record’s key. -

RecordType

Name Type Required Description Accepted Values
id string true The ID of the record type. -
name string false The name of the record type. Cerner recommends that the name be unique in a record type. Must not contain wildcard percent (%) or underscore (_) characters characters. -
mnemonic string true The mnemonic for the record type set. Must not contain wildcard percent (%), space () or underscore (_) characters. Must be under 30 characters. -
description string false The description of the record type. -
recordKeyFieldNames [string] true A list of one or more fields that make up the record’s key. -
createdAt string true The date and time when the record type was created, in ISO YYYY-MM-DDThh:mm:ss.SSSZ format. -

RecordTypes

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

postRecordTypeSetsRecordtypesetidRecordTypesRecordtypeidSchemas

Name Type Required Description Accepted Values
name string true The name of the record type schema. -
description string false The description of the record type schema. -
schema string true A Base64-encoded JSON schema to which a record type must adhere. -

RecordTypeSchema

Name Type Required Description Accepted Values
id string true The ID of the record type schema. -
name string true The name of the record type schema. -
description string false The description of the record type schema. -
schema string true A Base64-encoded JSON schema to which a record type must adhere. -
createdAt string true The date and time when the record type schema was created, in ISO YYYY-MM-DDThh:mm:ss.SSSZ format. -

RecordTypeSchemaGetAlls

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