NAV Navbar
Logo cerner
Ruby Shell

Universal Data Ingestion API v1

Universal data ingestion (UDI) is a file-based data collection method that is event-driven (based on when data is published or submitted) rather than time-driven (based on periodic scanning). It allows you to view metrics and gain insights about the quality of the data that is ingested into HealtheIntent from data sources.

Any data source that contributes batch file-based data to HealtheIntent must first be connected to the UDI service. Data source connections are managed using the Data Sources endpoints.

UDI uses data sets to group related contributed file sets for ingestion processing. Contributed files are identified by the data set ID, ordered by their release, then processed sequentially, ensuring that newer versions of an entity take precedence over older versions.

Before a file can be contributed to the platform, the file set specification the file adheres to must be connected to the data set. This connection is identified by a specification connection ID and is used to identify the file when using the Contributed Files endpoints to contribute a file.

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

Data Sources

The Data Sources endpoints are used to connnect existing data sources to the UDI service for file-based ingestion.

Retrieve a List of UDI 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/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.healtheintent.com/universal-data-ingestion/v1/data-sources \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "string",
      "legacyReleaseFormat": true
    }
  ],
  "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 all data sources connected to the UDI service.

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

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 UDI Data Source

Example Request:


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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0', headers: headers)

print JSON.pretty_generate(result)


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

PUT /data-sources/{dataSourceId}

Adds a UDI data source or updates a data source to be connected to the UDI service. If the data source is not already connected to the UDI service, it is added. If it is already connected, it is updated.

Parameters

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

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

Retrieve a Single UDI 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/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "string",
  "legacyReleaseFormat": true
}

GET /data-sources/{dataSourceId}

Retrieves a single data source connected to the UDI service.

Parameters

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

Response Statuses

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

Data Sets

Data sets are related file sets that are grouped for UDI ingestion processing.

Create a Data 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.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets', headers: headers)

print JSON.pretty_generate(result)




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

Example response

{
  "id": "string",
  "description": "string",
  "mnemonic": "string",
  "name": "string"
}

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

Creates a UDI data set for a data source.

Parameters

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

Response Statuses

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

Retrieve a List of Data 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.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "string",
      "description": "string",
      "mnemonic": "string",
      "name": "string"
    }
  ],
  "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-sets

Retrieves a list of UDI data sets for a data source.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of a 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. -
id query array[string] false N/A Filters the retrieved data sets to those with one of these IDs. A maximum of 20 IDs can be specified. -
mnemonic query string false N/A Filters the retrieved data sets to the one with this mnemonic. -

Response Statuses

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

Update a Data 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.patch('https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PATCH /data-sources/{dataSourceId}/data-sets/{dataSetId}

Updates a UDI data set.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of a data source. -
dataSetId path string true N/A The ID of a data set. -
body body patchDataSourcesDatasourceidDataSets 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 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.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "description": "string",
  "mnemonic": "string",
  "name": "string"
}

GET /data-sources/{dataSourceId}/data-sets/{dataSetId}

Retrieves a single UDI data set.

Parameters

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

Response Statuses

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

Specification Connections

Before a file can be contributed to the platform using the UDI service, the file set specification the file adheres to must be connected to the data set. A data set can have no specifications connected to it or many specifications. Additionally, file set specifications are reusable and can be connected to many data sets or no data sets.

Add a UDI Specification Connection

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/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3/specification-connections', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3/specification-connections \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

POST /data-sources/{dataSourceId}/data-sets/{dataSetId}/specification-connections

Adds a connection between a data source and data set combination and a file set specification.

Parameters

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

Response Statuses

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

Retrieve a List of UDI Specification Connections

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/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3/specification-connections', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3/specification-connections \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "string",
      "dataSetId": "string",
      "dataSourceId": "string",
      "fileSetSpecificationId": "string",
      "legacySpecVersion": "1"
    }
  ],
  "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-sets/{dataSetId}/specification-connections

Retrieves a list of UDI specification connections for a data source and data set combination.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of a data source. -
dataSetId path string true N/A The ID of a data set. -
id query array[string] false N/A Filters the retrieved specification connections to those with one of these IDs. A maximum of 20 IDs can be specified. -
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 SpecificationConnections
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single UDI Specification Connection

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/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3/specification-connections/adf35bfd-bc0e-469b-b306-00e04bd19914', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/data-sets/9e8688cb-a413-4efd-ae44-ba669a40dbc3/specification-connections/adf35bfd-bc0e-469b-b306-00e04bd19914 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "dataSetId": "string",
  "dataSourceId": "string",
  "fileSetSpecificationId": "string",
  "legacySpecVersion": "1"
}

GET /data-sources/{dataSourceId}/data-sets/{dataSetId}/specification-connections/{specificationConnectionId}

Retrieves a single UDI specification connection.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of a data source. -
dataSetId path string true N/A The ID of a data set. -
specificationConnectionId path string true N/A The ID of a specification connection. -

Response Statuses

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

File Set Specifications

File set specifications are a foundational part of the UDI service. Before file-based data can be contributed to the platform, the files must be defined so that the UDI service can correctly interpret them. A file set specification may contain a single file or multiple files. A multiple-file file set specification indicates that the UDI service cannot begin any processing until all the files in the set are received. File set specifications can serve as place to document details about the files and fields for all consumers to view.

Create a File Set Specification

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/universal-data-ingestion/v1/file-set-specifications', headers: headers)

print JSON.pretty_generate(result)




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

Example response

{
  "id": "string",
  "name": "string",
  "format": "CSV_SINGLE_FILE",
  "status": "PUBLISHED",
  "description": "string",
  "tags": "string"
}

POST /file-set-specifications

Creates a file set specification.

Parameters

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

Response Statuses

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

Retrieve a List of File Set Specifications

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/universal-data-ingestion/v1/file-set-specifications', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "format": "CSV_SINGLE_FILE",
      "status": "PUBLISHED",
      "description": "string",
      "tags": "string"
    }
  ],
  "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 /file-set-specifications

Retrieves a list of file set specifications based on the specified criteria. Only summaries of the specifications are retrieved, not the full details.

Parameters

Parameter In Type Required Default Description Accepted Values
tag query array[string] false N/A Filters the retrieved specifications to those with any of these tags. A maximum of 20 tags can be specified. -
id query array[string] false N/A Filters the retrieved specifications to those with one of these IDs. A maximum of 20 IDs can be specified. -
name query string false N/A Filters the retrieved specifications to those that match this name. Partial name matching is supported. -
status query array[string] false N/A Filters the retrieved specifications to those that are in one of these statuses. -
specificationFormat query array[string] false N/A Filters the retrieved specifications to those with one of these formats. -
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 FileSetSpecifications
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a File Set Specification

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /file-set-specifications/{fileSetSpecificationId}

Deletes a file set specification, including all child files, fields, and constraints. Only unpublished specifications can be deleted.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error
409 Conflict Resource Conflict Error

Update a File Set Specification

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PATCH https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PATCH /file-set-specifications/{fileSetSpecificationId}

Updates a file set specification. Only the name, description, tags, and status can be updated.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
body body patchFileSetSpecifications 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
409 Conflict Resource Conflict Error
422 Unprocessable Entity Unprocessable Entity Error

Retrieve a Single File Set Specification

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "name": "string",
  "format": "CSV_SINGLE_FILE",
  "status": "PUBLISHED",
  "description": "string",
  "tags": "string"
}

GET /file-set-specifications/{fileSetSpecificationId}

Retrieves a single file set specification by ID. Only a summary of the specification is retrieved, not the full details.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -

Response Statuses

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

Add a File

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "mnemonic": "SINGLE_FILE",
  "name": "string",
  "encoding": "UTF-8",
  "csvFileInfo": {},
  "fixedWidthFileInfo": {
    "recordGroupingFields": {},
    "multiFileJoinField": {}
  }
}

POST /file-set-specifications/{fileSetSpecificationId}/files

Adds a file to a file set specification. A file can be added to only a specification in an unpublished status. The following rules apply to files:
* If the parent specification is defined as one of the Character Separated Value (CSV) formats, csvFileInfo is required.
* If the parent specification is defined as one of the fixed-width (FW) formats, fixedWidthFileInfo is required.
* If the specification’s format is one of the SINGLE_FILE formats, only one file can be defined in the specification.
* If the specification’s format is CSV_SINGLE_FILE_GROUPED, the file’s CSVFileInfo.recordGroupingFieldIndices is required.
* If the specification’s format is FIXED_WIDTH_SINGLE_FILE_GROUPED, the file’s fixedWidthFileInfo.recordGroupingFields is required.
* If the specification’s format is CSV_MULTI_FILE, the file’s multiFileJoinFieldIndex is required.
* If the specification’s format is FIXED_WIDTH_MULTI_FILE, the file’s multiFileJoinField is required.
* Field indices are zero-based, so recordGroupingFieldIndices and multiFileJoinFieldIndex must be integers between zero and the fieldCount minus one.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
body body postFileSetSpecificationsFilesetspecificationidFiles true N/A No description -

Response Statuses

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

Retrieves a List of Files

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "string",
      "mnemonic": "SINGLE_FILE",
      "name": "string",
      "encoding": "UTF-8",
      "csvFileInfo": {},
      "fixedWidthFileInfo": {
        "recordGroupingFields": {},
        "multiFileJoinField": {}
      }
    }
  ],
  "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 /file-set-specifications/{fileSetSpecificationId}/files

Retrieves a list of all the files of a file set specification. Unpublished specifications can have no files defined.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
id query array[string] false N/A Filters the retrieved files to those matching these file IDs. A maximum of 20 IDs can be specified. -
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 FileSpecifications
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a File

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /file-set-specifications/{fileSetSpecificationId}/files/{fileId}

Deletes a file from a file set specification. Files can be deleted only when their parent specification is in an unpublished status. All fields and constraints associated with the file are deleted.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a File

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /file-set-specifications/{fileSetSpecificationId}/files/{fileId}

Updates a file of a file set specification. Files can be updated only when their parent specification is in an unpublished status. The following rules apply to files:
* If the parent specification is defined as one of the CSV formats, csvFileInfo is required.
* If the parent specification is defined as one of the FW formats, fixedWidthFileInfo is required.
* If the specification’s format is one of the SINGLE_FILE formats, only one file can be defined in the specification.
* If the specification’s format is CSV_SINGLE_FILE_GROUPED, the file’s CSVFileInfo.recordGroupingFieldIndices is required and field indexes must be between zero and the fieldCount minus one.
* If the specification’s format is FIXED_WIDTH_SINGLE_FILE_GROUPED, the file’s fixedWidthFileInfo.recordGroupingFields is required and field beginPosition plus the length must be less than the recordLength.
* If the specification’s format is CSV_MULTI_FILE, the file’s multiFileJoinFieldIndex is required and field indices must be between zero and the fieldCount minus one.
* If the specification’s format is FIXED_WIDTH_MULTI_FILE, the file’s multiFileJoinField is required and the field beginPosition plus the length must be less than the recordLength.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
body body putFileSetSpecificationsFilesetspecificationidFiles 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
409 Conflict Resource Conflict Error
422 Unprocessable Entity Unprocessable Entity Error

Retrieve a Single File

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "mnemonic": "SINGLE_FILE",
  "name": "string",
  "encoding": "UTF-8",
  "csvFileInfo": {},
  "fixedWidthFileInfo": {
    "recordGroupingFields": {},
    "multiFileJoinField": {}
  }
}

GET /file-set-specifications/{fileSetSpecificationId}/files/{fileId}

Retrieves a single file of a file set specification.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -

Response Statuses

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

Update Fields

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /file-set-specifications/{fileSetSpecificationId}/files/{fileId}/fields

Updates one or more fields of a file. The following general rules apply to fields:
* Fields can be added, updated, and deleted regardless of a specification’s status.
* For CSV specification formats, a csvFieldIndex for the field is required and must be equal to or less than the file’s fieldCount value.
* For CSV specification formats, no two fields can have the same csvFieldIndex value.
* For FW specification formats, fixedWidthFieldBeginPosition and fixedWidthFieldLength for the field are required and the highest fixedWidthFieldBeginPosition plus the fixedWidthFieldLength must be equal to or less than the file’s fixedWidthFileInfo.recordLength minus one.
* For FW specification formats, no two fields can have overlapping fixedWidthFieldBeginPosition and fixedWidthFieldLength values.

The following rules apply to updating fields:
If any of the fields to be updated are not found, no fields are updated and 404 HTTP status code (Not Found) is sent.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
body body FieldList false N/A The list of fields to be created. -

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 Resource Conflict Error
422 Unprocessable Entity Unprocessable Entity Error

Add Fields

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "csvFieldIndex": "0",
      "fixedWidthFieldBeginPosition": "0",
      "fixedWidthFieldLength": "0"
    }
  ]
}

POST /file-set-specifications/{fileSetSpecificationId}/files/{fileId}/fields

Adds one or more fields to a file. Adding a field does not impact the structural processing and transformation of the file set, but it does impact validation processing. The following rules apply to fields:
* Fields can be added, updated, and deleted regardless of a specification’s status.
* For CSV specification formats, csvFieldIndex is required for the field and must be equal to or less than the file’s fieldCount value.
* For CSV specification formats, no two fields can have the same csvFieldIndex value.
* For FW specification formats, a field’s fixedWidthFieldBeginPosition and fixedWidthFieldLength are required and the highest fixedWidthFieldBeginPosition plus the fixedWidthFieldLength must be equal to or less than the file’s fixedWidthFileInfo.recordLength minus one.
* For FW specification formats, no two fields can have overlapping fixedWidthFieldBeginPosition and fixedWidthFieldLength values.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
body body FieldList false N/A The list of fields to be created. -

Response Statuses

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

Retrieve a List of Fields

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "csvFieldIndex": "0",
      "fixedWidthFieldBeginPosition": "0",
      "fixedWidthFieldLength": "0"
    }
  ],
  "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 /file-set-specifications/{fileSetSpecificationId}/files/{fileId}/fields

Retrieves a list of the fields of a file. Fields may not be defined, or only some fields may be defined, meaning gaps may exist. The following rules apply to fields:
* If the specification’s format is one of the CSV formats, csvFieldIndex is populated.
* If the specification’s format is one of the FW formats, fixedWidthFieldBeginPosition and fixedWidthFieldLength are populated.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
id query array[string] false N/A Filters the retrieved fields to those matching these IDs. A maximum of 20 IDs can be specified. -
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 Fields
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single Field

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "name": "string",
  "description": "string",
  "csvFieldIndex": "0",
  "fixedWidthFieldBeginPosition": "0",
  "fixedWidthFieldLength": "0"
}

GET /file-set-specifications/{fileSetSpecificationId}/files/{fileId}/fields/{fieldId}

Retrieves a single field of a file.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
fieldId path string true N/A The ID of a field in a file. -

Response Statuses

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

Add a Constraint

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "constraintType": "REQUIRED",
  "numericType": "DECIMAL",
  "dateType": "ISO_8601_BASIC",
  "regExpression": "string",
  "enumerations": "string",
  "profile": "true"
}

POST /file-set-specifications/{fileSetSpecificationId}/files/{fileId}/fields/{fieldId}/constraints

A field constraint is a rule that must be enforced for that field in the context of the file in which it is contained. The UDI service uses the field constraints defined in the specification to validate the contributed files during file set validation processing. Each field constraint results in a data quality metric for the processing event. These metrics provide insight into whether the contributed files adhere to the defined constraints. The following rules apply to constraints:
* Constraints can be added, updated or deleted regardless of a specification’s status.
* The constraintType field indicates which constraint detail is required. For example, if the constraint type is NUMERIC_TYPE, the numericType field and only the numericType field must be populated. See Understand HealtheIntent Universal Data Ingestion Data Quality Metrics in the Reference Pages on Cerner Wiki for more information about the constraint types.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
fieldId path string true N/A The ID of a field in a file. -
body body postFileSetSpecificationsFilesetspecificationidFilesFileidFieldsFieldidConstraints true N/A No description -

Response Statuses

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

Retrieve a List of Constraints

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "string",
      "constraintType": "REQUIRED",
      "numericType": "DECIMAL",
      "dateType": "ISO_8601_BASIC",
      "regExpression": "string",
      "enumerations": "string",
      "profile": "true"
    }
  ],
  "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 /file-set-specifications/{fileSetSpecificationId}/files/{fileId}/fields/{fieldId}/constraints

Retrieves the constraints of a field.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
fieldId path string true N/A The ID of a field in a file. -
id query array[string] false N/A Filters the list of constraints to those matching the specified IDs. A maximum of 20 constraints can be specified. -
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 Constraints
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a Constraint

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints/827d14ef-bfce-4b0a-8486-a6d42ce2911d', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints/827d14ef-bfce-4b0a-8486-a6d42ce2911d \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /file-set-specifications/{fileSetSpecificationId}/files/{fileId}/fields/{fieldId}/constraints/{constraintId}

Deletes a constraint of a field. Constraints can be added updated or deleted regardless of a specification’s status.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
fieldId path string true N/A The ID of a field in a file. -
constraintId path string true N/A The ID of a constraint in a field. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Constraint

Example Request:




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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints/827d14ef-bfce-4b0a-8486-a6d42ce2911d', headers: headers)

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints/827d14ef-bfce-4b0a-8486-a6d42ce2911d \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'

PUT /file-set-specifications/{fileSetSpecificationId}/files/{fileId}/fields/{fieldId}/constraints/{constraintId}

Updates a constraint of a field.

Rules:
Constraints can be added, updated and deleted regardless of a specification’s status.
constraintType indicates which constraint detail is required.
If constraintType is NUMERIC_TYPE, the numericType detail, and only numericType detail, must be populated.
If constraintType is DATE_TYPE, the dateType detail, and only dateType detail, must be populated.
If constraintType is REG_EXPRESSION, the regExpression detail, and only regExpression detail, must be populated.
If constraintType is ENUMERATION, the enumerations detail, and only enumerations detail, must be populated.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
fieldId path string true N/A The ID of a field in a file. -
constraintId path string true N/A The ID of a constraint in a field. -
body body putFileSetSpecificationsFilesetspecificationidFilesFileidFieldsFieldidConstraints 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
409 Conflict Resource Conflict Error
422 Unprocessable Entity Unprocessable Entity Error

Retrieve a Single Constraint

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints/827d14ef-bfce-4b0a-8486-a6d42ce2911d', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/files/2969bcce-2372-46a2-97e0-107e11d466b4/fields/97b0c1b1-c367-45a0-84ae-4a02a1d2b2cf/constraints/827d14ef-bfce-4b0a-8486-a6d42ce2911d \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "constraintType": "REQUIRED",
  "numericType": "DECIMAL",
  "dateType": "ISO_8601_BASIC",
  "regExpression": "string",
  "enumerations": "string",
  "profile": "true"
}

GET /file-set-specifications/{fileSetSpecificationId}/files/{fileId}/fields/{fieldId}/constraints/{constraintId}

Retrieves a single constraint of a field.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
fileId path string true N/A The ID of a file in a file set specification. -
fieldId path string true N/A The ID of a field in a file. -
constraintId path string true N/A The ID of a constraint in a field. -

Response Statuses

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

Retrieve a List of File Set Validation Event Metric Descriptors

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/file-set-validation-metric-descriptors', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/file-set-validation-metric-descriptors \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "descriptorKey": "string",
      "name": "string",
      "description": "string",
      "classifiers": "string",
      "fileSetSpecification": {},
      "file": {},
      "field": {},
      "constraint": {}
    }
  ],
  "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 /file-set-specifications/{fileSetSpecificationId}/file-set-validation-metric-descriptors

Retrieves a list of the metric descriptors associated with the file set specification.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
descriptorKey query array[string] false N/A Filters the retrieved files to those matching these file IDs. A maximum of 20 IDs can be specified. -
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 FileSetValidationMetricDescriptors
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Single File Set Validation Event Metric Descriptor

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/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/file-set-validation-metric-descriptors/TOT_REC*FILE_1', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/file-set-specifications/549ede8d-362f-44be-9dca-4498781b68a0/file-set-validation-metric-descriptors/TOT_REC*FILE_1 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "descriptorKey": "string",
  "name": "string",
  "description": "string",
  "classifiers": "string",
  "fileSetSpecification": {},
  "file": {},
  "field": {},
  "constraint": {}
}

GET /file-set-specifications/{fileSetSpecificationId}/file-set-validation-metric-descriptors/{descriptorKey}

Retrieves a single metric descriptor associated with the file set specification.

Parameters

Parameter In Type Required Default Description Accepted Values
fileSetSpecificationId path string true N/A The ID of a file set specification. -
descriptorKey path string true N/A The unique ID of the the validation event metric descriptor. -

Response Statuses

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

Contributed Files

Data sources upload (or contribute) files to the platform to be processed using the UDI service. When a file is received by the platform, the service uses the file’s IDs (for example, the specification connection ID and file mnemonic) to locate its ingestion processing instructions. One of the first instructions is derived from the file’s specification, which is used to determine whether the file can be processed independently or is dependent on other files in the specification. Each time a contributed file is received, the UDI service creates a new contributed file set containing the new file plus any existing files as defined by the file set specification. When all the files in the set are received, the files are processed for ingestion onto the platform.

Archives a contributed file

Example Request:


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

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

result = HTTParty.put('https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-files/f134583d-59bb-4292-be45-3901f6cbaaab/archive', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-files/f134583d-59bb-4292-be45-3901f6cbaaab/archive \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /data-sources/{dataSourceId}/contributed-files/{contributedFileId}/archive

Archives a contributed file

Parameters

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

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 List of Contributed Files

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/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-files', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "string",
      "dataSourceId": "string",
      "dataSetId": "string",
      "specificationConnectionId": "string",
      "fileSetSpecificationId": "string",
      "fileMnemonic": "string",
      "release": "string",
      "originalFileName": "string",
      "fileSize": "string",
      "note": "string",
      "state": "ACTIVE",
      "receivedAt": "2018-09-20T11:32:57.041Z"
    }
  ],
  "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}/contributed-files

Retrieves a list of contributed files for the given data source.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
dataSetId query string false N/A Filters the retrieved contributed files to those matching this data set. -
fileSetSpecificationId query string false N/A Filters the retrieved contributed files to those matching this file set specification. -
fileMnemonic query string false N/A Filters the retrieved contributed files to those matching this file. -
contributedFileSetId query string false N/A Filters the retrieved contributed files to those included in this contributed file set. -
state query array[string] false N/A Filters the retrieved contributed files to those that are in one of these states. -
release query string false N/A Filters the retrieved contributed files to those match this release. Partial matching is supported, which means that any contributed file with a release that starts with the specified value is retrieved. For example, a query parameter value of 2018 matches release values of 20180101 and 20180202 while 201801 matches only 20180101. -
releasedAfter query string false N/A Filters the retrieved contributed files to those that release after this date, for example, 20181012 for YYYYMMD or 20181012102320 for YYYYMMDDhhmm. -
releasedBefore query string false N/A Filters the retrieved contributed files to those that release before this date, for example, 20181012 for YYYYMMD or 20181012102320 for YYYYMMDDhhmm. -
receivedAfter query string false N/A Filters the retrieved contributed file to those that were received after this date. Dates must be in the ISO 8601 format YYYY-MM-DDThh:mm:ss.SSSZ, for example 2018-09-23T11:32:57.041Z. -
receivedBefore query string false N/A Filters the retrieved contributed files to those that were received before this date. Dates must be in the ISO 8601 format YYYY-MM-DDThh:mm:ss.SSSZ, for example 2019-09-23T11:32:57.041Z. -
orderBy query string false N/A A comma-separated list of fields by which to sort. release, -release, receivedAt, -receivedAt
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 ContributedFiles
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Contributed File

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/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-files/f134583d-59bb-4292-be45-3901f6cbaaab', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-files/f134583d-59bb-4292-be45-3901f6cbaaab \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "dataSourceId": "string",
  "dataSetId": "string",
  "specificationConnectionId": "string",
  "fileSetSpecificationId": "string",
  "fileMnemonic": "string",
  "release": "string",
  "originalFileName": "string",
  "fileSize": "string",
  "note": "string",
  "state": "ACTIVE",
  "receivedAt": "2018-09-20T11:32:57.041Z"
}

GET /data-sources/{dataSourceId}/contributed-files/{contributedFileId}

Retrieves a single contributed file of a data source.

Parameters

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

Response Statuses

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

Retrieve a List of Contributed File 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.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-file-sets', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "string",
      "specificationConnectionId": "string",
      "fileSetSpecificationId": "string",
      "dataSourceId": "string",
      "dataSetId": "string",
      "release": "string",
      "contributedFiles": [
        {
          "id": "string",
          "dataSourceId": "string",
          "dataSetId": "string",
          "specificationConnectionId": "string",
          "fileSetSpecificationId": "string",
          "fileMnemonic": "string",
          "release": "string",
          "originalFileName": "string",
          "fileSize": "string",
          "note": "string",
          "state": "ACTIVE",
          "receivedAt": "2018-09-20T11:32:57.041Z"
        }
      ],
      "state": "COMPLETE",
      "createdAt": "2018-09-20T11:32:57.041Z",
      "receivedAt": "2018-09-20T11:32:57.041Z"
    }
  ],
  "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}/contributed-file-sets

Retrieves a list of contributed file sets for the given data source.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
specificationConnectionId query string false N/A Filters the retrieved contributed file sets to those matching this specification connection. -
contributedFileId query string false N/A Filters the retrieved contributed file sets to those that contain this contributed file. -
state query array[string] false N/A Filters the retrieved contributed file sets to those that are in one of these states. -
dataSetId query string false N/A Filters the retrieved contributed file sets to those that belong to this data set. -
release query string false N/A Filters the retrieved contributed file sets to those that match this release. Partial matching is supported, which means that any contributed file set with a release that starts with the specified value is retrieved. For example, a query parameter value of 2018 matches release values of 20180101 and 20180202 while 201801 matches only 20180101. -
releasedAfter query string false N/A Filters the retrieved contributed file sets to those that release after this date, for example 20181012 in YYYYMMDD format or 20181012102320 in YYYYMMDDhhmm format. -
releasedBefore query string false N/A Filters the retrieved contributed file sets to those that release before this date, for example 20181012 in YYYYMMDD format or 20181012102320 in YYYYMMDDhhmm format. -
receivedAfter query string false N/A Filters the retrieved contributed file sets to those that were received after this date. Dates must be in the ISO 8601 format YYYY-MM-DDThh:mm:ss.SSSZ, for example 2018-09-23T11:32:57.041Z. -
receivedBefore query string false N/A Filters the retrieved contributed file sets to those that were received before this date. Dates must be in the ISO 8601 format YYYY-MM-DDThh:mm:ss.SSSZ, for example 2019-09-23T11:32:57.041Z. -
orderBy query string false N/A A comma-separated list of fields by which to sort. release, -release, createdAt, -createdAt
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 ContributedFileSets
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Contributed File 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.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-file-sets/f134583d-59bb-4292-be45-3901f6cbaaab', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-file-sets/f134583d-59bb-4292-be45-3901f6cbaaab \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "specificationConnectionId": "string",
  "fileSetSpecificationId": "string",
  "dataSourceId": "string",
  "dataSetId": "string",
  "release": "string",
  "contributedFiles": [
    {
      "id": "string",
      "dataSourceId": "string",
      "dataSetId": "string",
      "specificationConnectionId": "string",
      "fileSetSpecificationId": "string",
      "fileMnemonic": "string",
      "release": "string",
      "originalFileName": "string",
      "fileSize": "string",
      "note": "string",
      "state": "ACTIVE",
      "receivedAt": "2018-09-20T11:32:57.041Z"
    }
  ],
  "state": "COMPLETE",
  "createdAt": "2018-09-20T11:32:57.041Z",
  "receivedAt": "2018-09-20T11:32:57.041Z"
}

GET /data-sources/{dataSourceId}/contributed-file-sets/{contributedFileSetId}

Retrieves a single contributed file set for the given data source.

Parameters

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

Response Statuses

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

Upload a Contributed File

Example Request:


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

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json',
  'Content-Type' => {
  "type": "string"
},
  'Content-Encoding' => {
  "type": "string",
  "default": "gzip"
},
  'Transfer-Encoding' => {
  "type": "string"
},
  'Cerner-Correlation-Id' => {
  "type": "string"
}
} 

result = HTTParty.post('https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/specification-connections/920dac4a-a1bd-4169-bdac-ab98db41e88b/contributed-files', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X POST https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/specification-connections/920dac4a-a1bd-4169-bdac-ab98db41e88b/contributed-files \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json' \
-H 'Content-Type: [object Object]' \
-H 'Content-Encoding: [object Object]' \
-H 'Transfer-Encoding: [object Object]' \
-H 'Cerner-Correlation-Id: [object Object]'

Example response

{
  "id": "string",
  "dataSourceId": "string",
  "dataSetId": "string",
  "specificationConnectionId": "string",
  "fileSetSpecificationId": "string",
  "fileMnemonic": "string",
  "release": "string",
  "originalFileName": "string",
  "fileSize": "string",
  "note": "string",
  "state": "ACTIVE",
  "receivedAt": "2018-09-20T11:32:57.041Z"
}

POST /specification-connections/{specificationConnectionId}/contributed-files

Uploads a contributed file to the platform for UDI processing. The body contains a binary representation of a file prefixed with Multipurpose Internet Mail Extensions (MIME) headers.

General Structure

The general structure below is used. Note that a blank line is required after the last MIME header parameter and the start of the value bytes.
{boundary}
{header-name}: {header-value}
{header-name}: {header-value}

{value-bytes}
{boundary}

MIME Headers

The following MIME headers can be used:

Release: A required MIME header that represents the release of the contributed file in either YYYYMMDD or YYYYMMDDhhmm format. The release along with the data source, data set, and file set specification IDs are used to identify the contributed files that are grouped into a contributed file set.
File-Mnemonic: An optional MIME header that represents the human-readable ID (for example, SINGLE_FILE, FILE_1, or FILE_2) of the file in the file set specification that the contributed file adheres to. If the file set specification contains only a single file, this header is not required as it is assumed to be SINGLE_FILE.
Original-File-Name: An optional MIME header that represents the name of the file in the local file system. It can also include the local file system path.

Note: An optional MIME header that represents a note or comment pertaining to the file. Typically. a note is used when a user manually uploads a file and wants to describe why the upload was necessary.

Parameters

Parameter In Type Required Default Description Accepted Values
Content-Type header string true N/A Indicates that the request is a MIME multipart message according to RFC 2045 and RFC 2046.

Value:
multipart/mixed; boundary={boundary}

The boundary value must not occur within the data of any of the parts. Programmatically generating a random UUID at the boundary is usually how that is ensured.

Example Value:
multipart/mixed; boundary=bbf9d986-aa7e-48e2-909e-8b7e69257d8f
-
Content-Encoding header string false gzip Indicates that the request body is compressed. The only supported encoding scheme is gzip and must adhere to the RFC 1952 standard. It is recommended to use compression for large files. -
Transfer-Encoding header string false N/A Indicates that the request data is sent in chunks and adheres to the RFC 2616 standard. Chunking of the request is recommended for large files. A reasonable maximum chunk size might range from about 16 KB to 64 KB.

See RFC 2616 - Section 3.6 for more information on chunking.

Example Value:
chunked
-
Cerner-Correlation-Id header string false N/A Optional, but strongly recommended, ID that can be used to trace request through services. This ID aids the investigation of issues. Typically, a randomly generated UUID is used. -
specificationConnectionId path string true N/A The ID of a file set specification connection. -

Response Statuses

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

File Set Validation Events

File set validation events are events in which contributed file sets are validated against their file set specifications. Validation events produce metrics that provide insight into the quality of the contributed data. See Understand HealtheIntent Universal Data Ingestion Data Quality Metrics in the Reference Pages on Cerner Wiki for more information.

Retrieve a List of File Set Validation Events

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/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-file-sets/f134583d-59bb-4292-be45-3901f6cbaaab/file-set-validation-events', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-file-sets/f134583d-59bb-4292-be45-3901f6cbaaab/file-set-validation-events \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "string",
      "fileSetSpecificationId": "string",
      "beginAt": "2018-09-20T02:49:10.941Z",
      "endAt": "2018-09-20T02:49:10.941Z",
      "status": "COMPLETED"
    }
  ],
  "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}/contributed-file-sets/{contributedFileSetId}/file-set-validation-events

Retrieves a list of the file set validation processing events for a contributed file set.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
contributedFileSetId path string true N/A The ID of the contributed file set. -
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 FileSetValidationEvents
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single File Set Validation Event

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/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-file-sets/f134583d-59bb-4292-be45-3901f6cbaaab/file-set-validation-events/291c99b7-67d3-419f-b896-8a5f4f007100', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-file-sets/f134583d-59bb-4292-be45-3901f6cbaaab/file-set-validation-events/291c99b7-67d3-419f-b896-8a5f4f007100 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "string",
  "fileSetSpecificationId": "string",
  "beginAt": "2018-09-20T02:49:10.941Z",
  "endAt": "2018-09-20T02:49:10.941Z",
  "status": "COMPLETED"
}

GET /data-sources/{dataSourceId}/contributed-file-sets/{contributedFileSetId}/file-set-validation-events/{fileSetValidationEventId}

Retrieves a single file set validation processing event for a contributed file set.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
contributedFileSetId path string true N/A The ID of the contributed file set. -
fileSetValidationEventId path string true N/A The unique ID of the validation event. -

Response Statuses

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

Retrieve a List of File Set Validation Event Metrics

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/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-file-sets/f134583d-59bb-4292-be45-3901f6cbaaab/file-set-validation-events/291c99b7-67d3-419f-b896-8a5f4f007100/metrics', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/universal-data-ingestion/v1/data-sources/11e8901dafad94f7a9b701d255a00ad0/contributed-file-sets/f134583d-59bb-4292-be45-3901f6cbaaab/file-set-validation-events/291c99b7-67d3-419f-b896-8a5f4f007100/metrics \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "fileSetValidationMetricDescriptor": [
        {
          "descriptorKey": "string",
          "fileSetSpecificationId": "string",
          "name": "string"
        }
      ],
      "value": "0"
    }
  ],
  "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}/contributed-file-sets/{contributedFileSetId}/file-set-validation-events/{fileSetValidationEventId}/metrics

Retrieves a list of data quality metrics for a file set validation processing event. These metrics provide insight into the adherence of the contributed file set to its file set specification. See Understand HealtheIntent Universal Data Ingestion Data Quality Metrics in the Reference Pages on Cerner Wiki for more information.

Parameters

Parameter In Type Required Default Description Accepted Values
dataSourceId path string true N/A The ID of the data source. -
contributedFileSetId path string true N/A The ID of the contributed file set. -
fileSetValidationEventId path string true N/A The ID of the file set validation event. -
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 FileSetValidationMetrics
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

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

DataSources

Name Type Required Description Accepted Values
items [DataSource] true [Retrieves a single data source connected to the UDI service.] -
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. -

DataSource

Name Type Required Description Accepted Values
id string false The unique ID of the data source. -
legacyReleaseFormat boolean false Indicates whether legacy release formats are accepted for a contributed file that is produced by the data source. -

ContributedFiles

Name Type Required Description Accepted Values
items [ContributedFile] true [Uploads a contributed file to the platform for UDI processing. The body contains a binary representation of a file prefixed with Multipurpose Internet Mail Extensions (MIME) headers.

General Structure

The general structure below is used. Note that a blank line is required after the last MIME header parameter and the start of the value bytes.
{boundary}
{header-name}: {header-value}
{header-name}: {header-value}

{value-bytes}
{boundary}

MIME Headers

The following MIME headers can be used:

Release: A required MIME header that represents the release of the contributed file in either YYYYMMDD or YYYYMMDDhhmm format. The release along with the data source, data set, and file set specification IDs are used to identify the contributed files that are grouped into a contributed file set.
File-Mnemonic: An optional MIME header that represents the human-readable ID (for example, SINGLE_FILE, FILE_1, or FILE_2) of the file in the file set specification that the contributed file adheres to. If the file set specification contains only a single file, this header is not required as it is assumed to be SINGLE_FILE.
Original-File-Name: An optional MIME header that represents the name of the file in the local file system. It can also include the local file system path.

Note: An optional MIME header that represents a note or comment pertaining to the file. Typically. a note is used when a user manually uploads a file and wants to describe why the upload was necessary.]
-
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. -

ContributedFile

Name Type Required Description Accepted Values
id string true The unique ID of the contributed file. -
dataSourceId string true The ID of the data source from which the file was contributed. -
dataSetId string true The ID of the UDI data set, derived from the specification connection with which the contributed file was uploaded. The specification combination along with the release allows the UDI service to group the contribute file into contributed data releases for processing. -
specificationConnectionId string false The ID of the specification connection with which the contributed file was uploaded. -
fileSetSpecificationId string true The ID of the UDI file set specification to which the contribute file belongs. -
fileMnemonic string true The human-readable ID (for example, FILE_1) of the file in the file set specification that the contributed file represents and follows. -
release string true The release of the contributed file, in either YYYYMMDD or YYYYMMDDhhmm format. The release, data source ID, data set ID, and file set specification ID are used to identify the contributed files that are grouped in a contributed file set. Files that were contributed before the format was enforced may have release values that do not conform to the YYYYMMDD or YYYYMMDDhhmm format. -
originalFileName string false The original name of the file from the data source if it was provided when the file was uploaded. -
fileSize integer(int32) false The size of the contributed file in bytes. -
note string false The note provided when the file was uploaded. Notes are typically used to provide context about the contributed file. -
state string false The current state of the contributed file. The state determines the availability of the file on the platform, specifically for UDI processing. A contributed file in an active state is available to be processed and published to a UDI data partition. A contributed file in an archived state is not available for UDI processing. An archived file was active in the past and is still present on the platform but is logically removed and not available for future UDI processing. ACTIVE, ARCHIVED
receivedAt string false The time when the file was received, in ISO YYYY-MM-DDThh:mm:ss.SSSZ format. -

ContributedFileSets

Name Type Required Description Accepted Values
items [ContributedFileSet] true [Retrieves a single contributed file set for the given data source.] -
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. -

ContributedFileSet

Name Type Required Description Accepted Values
id string true The unique ID of the contributed file set. -
specificationConnectionId string true The ID of the specification connection with which the contributed file set was created. -
fileSetSpecificationId string true The ID of the file set specification to which the contributed file set adheres, as identified by the specification connection used during creation. -
dataSourceId string true The ID of the data source from which the file was contributed. -
dataSetId string true The ID of the data set in which the contributed file is grouped, as identified by the specification connection used during creation. -
release string true The release of the contributed file, in either YYYYMMDD or YYYYMMDDhhmm format. The release, data source ID, data set ID, and file set specification ID are used to identify the contributed files that are grouped in a contributed file set. Files contributed before the format was enforced may have release values that do not conform to the YYYYMMDD or YYYYMMDDhhmm format. -
contributedFiles [ContributedFile] true The contributed files that are contained in this contributed file set. -
state string true The state of the contributed file set. INCOMPLETE indicates that the file set is missing one or more files as defined by the file set specification. COMPLETE indicates that the file set contains all the files as defined by the specification. ARCHIVED indicates that the file set was complete at some time in the past but one or more files have since been archived, thereby rendering the file set archived as well. An archived contributed file set is still present on the platform but is not processed in the future. INCOMPLETE, COMPLETE, ARCHIVED
createdAt string false The time when the file set was created, in ISO YYYY-MM-DDThh:mm:ss.SSSZ format. -
receivedAt string false The time when the file set was received, in ISO YYYY-MM-DDThh:mm:ss.SSSZ format. -

FileSetValidationEvents

Name Type Required Description Accepted Values
items [FileSetValidationEvent] true [Retrieves a single file set validation processing event for a contributed file set.] -
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. -

FileSetValidationEvent

Name Type Required Description Accepted Values
id string true The unique ID of the file set validation event. -
fileSetSpecificationId string true The ID of the file set specification against which the contributed file set was validated. -
beginAt string(date-time) true The date and time when the processing event began, in International Organization for Standardization (ISO) 8601 extended format. -
endAt string(date-time) false The date and time when the processing event ended, in ISO 8601 extended format. -
status string true The status of the processing event. An in-progress event has started but has not completed. A completed event has successfully completed. A failed event encountered an error that caused the process to fail. A skipped event indicates the process was skipped due to a change in the state of the contributed file set, for example, if it was changed to an archived state. IN_PROGRESS, COMPLETED, FAILED, SKIPPED

FileSetValidationMetrics

Name Type Required Description Accepted Values
items [FileSetValidationMetric] true No description -
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. -

FileSetValidationMetric

Name Type Required Description Accepted Values
fileSetValidationMetricDescriptor [ValidationEventMetricDescriptor] false No description -
value integer(int32) true The value of the metric. -

ValidationEventMetricDescriptor

Name Type Required Description Accepted Values
descriptorKey string false Unique identifier for the metric descriptor. -
fileSetSpecificationId string false Pointer the file set specification used during the validation event that produced the metric. Denormalized from the event. -
name string false Display name of the metric. -

postDataSourcesDatasourceidDataSets

Name Type Required Description Accepted Values
mnemonic string true The human-readable ID of the data set. The mnemonic uniquely identifies a data set in a data source but not across all data sets. -
name string true The name of the data set. -
description string false The description of the data set. -

DataSet

Name Type Required Description Accepted Values
id string false The unique ID of the data set. -
description string false The description of the data set. -
mnemonic string false The human-readable ID of the data set. The mnemonic uniquely identifies a data set in a data source but not across all data sets. -
name string false The name of the data set. -

DataSets

Name Type Required Description Accepted Values
items [DataSet] true [Retrieves a single UDI data set.] -
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. -

patchDataSourcesDatasourceidDataSets

Name Type Required Description Accepted Values
description string false The description of the data set. -
name string false The name of the data set. -

postDataSourcesDatasourceidDataSetsDatasetidSpecificationConnections

Name Type Required Description Accepted Values
fileSetSpecificationId string true The ID of the file set specification connected to the data source and data set combination. -

SpecificationConnection

Name Type Required Description Accepted Values
id string false The unique ID of the specification connection. -
dataSetId string false The ID of the data set in this specification connection. -
dataSourceId string false The ID of the data source to which this specification connection’s data set belongs. -
fileSetSpecificationId string false The ID of the file set specification connected to the data source and data set combination. -
legacySpecVersion string false The version of the file set specification in the connected data set. Provided to allow using the connection to be a passive change from the existing ingestion service. -

SpecificationConnections

Name Type Required Description Accepted Values
items [SpecificationConnection] true [Retrieves a single UDI specification connection.] -
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. -

postFileSetSpecifications

Name Type Required Description Accepted Values
name string true The name of the file set specification. -
format string true The format of the files in the specification. The format cannot be modified after the specification is created. CSV_SINGLE_FILE, CSV_SINGLE_FILE_GROUPED, CSV_MULTI_FILE, FIXED_WIDTH_SINGLE_FILE, FIXED_WIDTH_SINGLE_FILE_GROUPED, FIXED_WIDTH_MULTI_FILE
tags [string] false Tags can be used to group related file set specifications and to help with identification. -
description string false The description of the file set specification. -

FileSetSpecification

Name Type Required Description Accepted Values
id string false The unique ID of the file set specification. -
name string false The name of the file set specification. -
format string false The format of the files in the specification. The format cannot be modified after the specification is created. CSV_SINGLE_FILE, CSV_SINGLE_FILE_GROUPED, CSV_MULTI_FILE, FIXED_WIDTH_SINGLE_FILE, FIXED_WIDTH_SINGLE_FILE_GROUPED, FIXED_WIDTH_MULTI_FILE
status string false The status of the file set specification. An unpublished specification is still being authored and cannot be connected to a data set, which prevents it from being used to contribute files to the platform. An unpublished specification can be deleted or modified, including adding, updating, and deleting child files. An unpublished specification’s status can only be changed to published. A published specification is ready for use, meaning that it can be connected to a data set, which allows it to be used to contribute files to the platform. A published specification cannot be modified nor can any of its child files be added, updated, or deleted. However, fields and constraints can still be modified. A published specification’s status can only be changed to deprecated. A deprecated specification indicates that a newer specification is available. Predominantly, a deprecated specification has the same characteristics as a published specification except its status cannot be changed. UNPUBLISHED, PUBLISHED, DEPRECATED
description string false The description of the file set specification. -
tags [string] false Tags can be used to group related file set specifications and to help with identification. -

FileSetSpecifications

Name Type Required Description Accepted Values
items [FileSetSpecification] true [Retrieves a single file set specification by ID. Only a summary of the specification is retrieved, not the full details.] -
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. -

patchFileSetSpecifications

Name Type Required Description Accepted Values
name string false The name of the file set specification. -
description string false The description of the file set specification. -
tags [string] false Tags can be used to group related file set specifications and to help with identification. -
status string false The status of the file set specification. An unpublished specification is still being authored and cannot be connected to a data set, which prevents it from being used to contribute files to the platform. An unpublished specification can be deleted or modified, including adding, updating, and deleting child files. An unpublished specification’s status can only be changed to published. A published specification is ready for use, meaning that it can be connected to a data set, which allows it to be used to contribute files to the platform. A published specification cannot be modified nor can any of its child files be added, updated, or deleted. However, fields and constraints can still be modified. A published specification’s status can only be changed to deprecated. A deprecated specification indicates that a newer specification is available. Predominantly, a deprecated specification has the same characteristics as a published specification except its status cannot be changed. UNPUBLISHED, PUBLISHED, DEPRECATED

CSVFileInfo

Name Type Required Description Accepted Values
fieldCount integer(int32) false The number of fields in the file. Must be greater than zero. -
delimiter string false The character used as the field delimiter. PIPE, TAB, COMMA, CARET
parsingType string false The type of parsing. Basic parsing uses only the record terminator and the field delimiter to parse the .CSV file. If a record terminator character (for example, CR) is present in the field content, that record is terminated prematurely, resulting in the remainder of the record being considered a new record. Additionally, if a field delimiter character is present in the field content, that field content is split inaccurately into two fields, which disrupts the remaining fields in the record. Advanced parsing supports the use of the double quotation mark (DQUOTE U+0022) character to identify the begin and end of the field content. Any field delimiter character or record terminator in the field content is not recognized as such if the field content is surrounded by double quotes. See HealtheIntent Character Separated Value (CSV) File Specification in the Reference Pages on Cerner Wiki for more information. BASIC, ADVANCED
hasHeaderRecord boolean false Indicates whether the file has a header record. A header record, if present (true), is always the first record of a .CSV file. This allows the UDI service to determine whether to skip the first record during processing. -
recordGroupingFieldIndices [integer] false A list of field indexes used to group related records. Only applicable to the CSV_SINGLE_FILE_GROUPED format type. -
multiFileJoinFieldIndex integer(int32) false The field index used to join records from this file to records of the other files in the specification. Only applicable to the CSV_MULTI_FILE format type. -

FixedWidthFileInfo

Name Type Required Description Accepted Values
recordLength integer(int32) false The record length of the file. -
recordGroupingFields [RecordGroupingField] false No description -
multiFileJoinField MultiFileJoinField false No description -

RecordGroupingField

Name Type Required Description Accepted Values
beginPosition integer(int32) false The field begin position. -
length integer(int32) false The field length. -

MultiFileJoinField

Name Type Required Description Accepted Values
beginPosition integer(int32) false The field begin position. -
length integer(int32) false The field length. -

postFileSetSpecificationsFilesetspecificationidFiles

Name Type Required Description Accepted Values
mnemonic string true The unique human-readable ID that identifies a file in its parent file set specification. The allowed mnemonic values are restricted to SINGLE_FILE and FILE_1 through FILE_20. SINGLE_FILE, FILE_1, FILE_2, FILE_3, FILE_4, FILE_5, FILE_6, FILE_7, FILE_8, FILE_9, FILE_10, FILE_11, FILE_12, FILE_13, FILE_14, FILE_15, FILE_16, FILE_17, FILE_18, FILE_19, FILE_20
name string true The name of the file. -
encoding string true No description UTF-8, ISO-8859-1, WINDOWS-1252
csvFileInfo CSVFileInfo false No description -
fixedWidthFileInfo FixedWidthFileInfo false No description -

FileSpecification

Name Type Required Description Accepted Values
id string false The globally unique ID of the file. -
mnemonic string false The unique human-readable ID that identifies a file in its parent file set specification. The allowed mnemonic values are restricted to SINGLE_FILE and FILE_1 through FILE_20. SINGLE_FILE, FILE_1, FILE_2, FILE_3, FILE_4, FILE_5, FILE_6, FILE_7, FILE_8, FILE_9, FILE_10, FILE_11, FILE_12, FILE_13, FILE_14, FILE_15, FILE_16, FILE_17, FILE_18, FILE_19, FILE_20
name string false The name of the file. -
encoding string false No description UTF-8, ISO-8859-1, WINDOWS-1252
csvFileInfo CSVFileInfo false No description -
fixedWidthFileInfo FixedWidthFileInfo false No description -

FileSpecifications

Name Type Required Description Accepted Values
items [FileSpecification] true [Retrieves a single file of a file set specification.] -
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. -

putFileSetSpecificationsFilesetspecificationidFiles

Name Type Required Description Accepted Values
mnemonic string false The unique human-readable ID that identifies a file in its parent file set specification. The allowed mnemonic values are restricted to SINGLE_FILE and FILE_1 through FILE_20. SINGLE_FILE, FILE_1, FILE_2, FILE_3, FILE_4, FILE_5, FILE_6, FILE_7, FILE_8, FILE_9, FILE_10, FILE_11, FILE_12, FILE_13, FILE_14, FILE_15, FILE_16, FILE_17, FILE_18, FILE_19, FILE_20
name string false The name of the file. -
encoding string false No description UTF-8, ISO-8859-1, WINDOWS-1252
csvFileInfo CSVFileInfo false No description -
fixedWidthFileInfo FixedWidthFileInfo false No description -

Field

Name Type Required Description Accepted Values
id string false The unique ID of the field. -
name string false The name of the field. -
description string false The description name of the field. -
csvFieldIndex integer(int32) false The index of a CSV field. The first field of a .CSV file has an index of zero. -
fixedWidthFieldBeginPosition integer(int32) false The begin position of a FW field. The first field of a FW file begins at zero. -
fixedWidthFieldLength integer(int32) false The length of a FW field. -

FieldList

Name Type Required Description Accepted Values
items [Field] false The list of created fields. -

Fields

Name Type Required Description Accepted Values
items [Field] true [Retrieves a single field of a file.] -
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. -

postFileSetSpecificationsFilesetspecificationidFilesFileidFieldsFieldidConstraints

Name Type Required Description Accepted Values
constraintType string false The type of constraint. If the type is NUMERIC_TYPE, numericType is required. If the type is DATE_TYPE, dateType is required. If the type is REG_EXPRESSION, regExpression is required. If the type is ENUMERATION, enumerations is required. See Understand HealtheIntent Universal Data Ingestion Data Quality Metrics in the Reference Pages on Cerner Wiki for more information. REQUIRED, NUMERIC_TYPE, DATE_TYPE, REG_EXPRESSION, ENUMERATION
numericType string false The numeric constraint. DECIMAL, INTEGER, LONG, NON_NEG_INTEGER, POS_INTEGER, NON_NEG_DECIMAL, POS_DECIMAL
dateType string false The date constraint. ISO_8601_BASIC, ISO_8601_EXTENDED, DD_MM_YYYY_SLASHES, YYYYMMDD, YYYYMMDDHHMM, YYYYMMDDHHMMSS
regExpression string false The regular expression constraint. -
enumerations [string] false The enumeration constraint. -
profile boolean false Indicates whether to profile the field. -

Constraint

Name Type Required Description Accepted Values
id string false The unique ID of the constraint. -
constraintType string false The type of constraint. If the type is NUMERIC_TYPE, numericType is required. If the type is DATE_TYPE, dateType is required. If the type is REG_EXPRESSION, regExpression is required. If the type is ENUMERATION, enumerations is required. See Understand HealtheIntent Universal Data Ingestion Data Quality Metrics in the Reference Pages on Cerner Wiki for more information. REQUIRED, NUMERIC_TYPE, DATE_TYPE, REG_EXPRESSION, ENUMERATION
numericType string false The numeric constraint. DECIMAL, INTEGER, LONG, NON_NEG_INTEGER, POS_INTEGER, NON_NEG_DECIMAL, POS_DECIMAL
dateType string false The date constraint. ISO_8601_BASIC, ISO_8601_EXTENDED, DD_MM_YYYY_SLASHES, YYYYMMDD, YYYYMMDDHHMM, YYYYMMDDHHMMSS
regExpression string false The regular expression constraint. -
enumerations [string] false The enumeration constraint. -
profile boolean false Indicates whether to profile the field. -

Constraints

Name Type Required Description Accepted Values
items [Constraint] true [Retrieves a single constraint of a field.] -
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. -

putFileSetSpecificationsFilesetspecificationidFilesFileidFieldsFieldidConstraints

Name Type Required Description Accepted Values
constraintType string false The type of constraint. If the type is NUMERIC_TYPE, numericType is required. If the type is DATE_TYPE, dateType is required. If the type is REG_EXPRESSION, regExpression is required. If the type is ENUMERATION, enumerations is required. See Understand HealtheIntent Universal Data Ingestion Data Quality Metrics in the Reference Pages on Cerner Wiki for more information. REQUIRED, NUMERIC_TYPE, DATE_TYPE, REG_EXPRESSION, ENUMERATION
numericType string false The numeric constraint. DECIMAL, INTEGER, LONG, NON_NEG_INTEGER, POS_INTEGER, NON_NEG_DECIMAL, POS_DECIMAL
dateType string false The date constraint. ISO_8601_BASIC, ISO_8601_EXTENDED, DD_MM_YYYY_SLASHES, YYYYMMDD, YYYYMMDDHHMM, YYYYMMDDHHMMSS
regExpression string false The regular expression constraint. -
enumerations [string] false The enumeration constraint. -
profile boolean false Indicates whether to profile the field. -

FileSetValidationMetricDescriptors

Name Type Required Description Accepted Values
items [FileSetValidationMetricDescriptor] true [Retrieves a single metric descriptor associated with the file set specification.] -
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. -

FileSetValidationMetricDescriptor

Name Type Required Description Accepted Values
descriptorKey string true The unique ID of the metric descriptor. -
name string false The display name of the metric descriptor. -
description string false The description of the metric descriptor. -
classifiers [string] false An array of classifiers that provide additional context about the metric, for example, INFO or CONSTRAINT. -
fileSetSpecification GenericResourceReference false No description -
file GenericResourceReference false No description -
field GenericResourceReference false No description -
constraint GenericResourceReference false No description -

GenericResourceReference

Name Type Required Description Accepted Values
id string false Pointer to the generic resource reference in the file set specification to which the metric applies. -