DNAnexus Documentation
APIDownloadsIndex of dx CommandsLegal
  • Overview
  • Getting Started
    • DNAnexus Essentials
    • Key Concepts
      • Projects
      • Organizations
      • Apps and Workflows
    • User Interface Quickstart
    • Command Line Quickstart
    • Developer Quickstart
    • Developer Tutorials
      • Bash
        • Bash Helpers
        • Distributed by Chr (sh)
        • Distributed by Region (sh)
        • SAMtools count
        • TensorBoard Example Web App
        • Git Dependency
        • Mkfifo and dx cat
        • Parallel by Region (sh)
        • Parallel xargs by Chr
        • Precompiled Binary
        • R Shiny Example Web App
      • Python
        • Dash Example Web App
        • Distributed by Region (py)
        • Parallel by Chr (py)
        • Parallel by Region (py)
        • Pysam
      • Web App(let) Tutorials
        • Dash Example Web App
        • TensorBoard Example Web App
      • Concurrent Computing Tutorials
        • Distributed
          • Distributed by Region (sh)
          • Distributed by Chr (sh)
          • Distributed by Region (py)
        • Parallel
          • Parallel by Chr (py)
          • Parallel by Region (py)
          • Parallel by Region (sh)
          • Parallel xargs by Chr
  • User
    • Login and Logout
    • Projects
      • Project Navigation
      • Path Resolution
    • Running Apps and Workflows
      • Running Apps and Applets
      • Running Workflows
      • Running Nextflow Pipelines
      • Running Batch Jobs
      • Monitoring Executions
      • Job Notifications
      • Job Lifecycle
      • Executions and Time Limits
      • Executions and Cost and Spending Limits
      • Smart Reuse (Job Reuse)
      • Apps and Workflows Glossary
      • Tools List
    • Cohort Browser
      • Chart Types
        • Row Chart
        • Histogram
        • Box Plot
        • List View
        • Grouped Box Plot
        • Stacked Row Chart
        • Scatter Plot
        • Kaplan-Meier Survival Curve
      • Locus Details Page
    • Using DXJupyterLab
      • DXJupyterLab Quickstart
      • Running DXJupyterLab
        • FreeSurfer in DXJupyterLab
      • Spark Cluster-Enabled DXJupyterLab
        • Exploring and Querying Datasets
      • Stata in DXJupyterLab
      • Running Older Versions of DXJupyterLab
      • DXJupyterLab Reference
    • Using Spark
      • Apollo Apps
      • Connect to Thrift
      • Example Applications
        • CSV Loader
        • SQL Runner
        • VCF Loader
      • VCF Preprocessing
    • Environment Variables
    • Objects
      • Describing Data Objects
      • Searching Data Objects
      • Visualizing Data
      • Filtering Objects and Jobs
      • Archiving Files
      • Relational Database Clusters
      • Symlinks
      • Uploading and Downloading Files
        • Small File Sets
          • dx upload
          • dx download
        • Batch
          • Upload Agent
          • Download Agent
    • Platform IDs
    • Organization Member Guide
    • Index of dx commands
  • Developer
    • Developing Portable Pipelines
      • dxCompiler
    • Cloud Workstation
    • Apps
      • Introduction to Building Apps
      • App Build Process
      • Advanced Applet Tutorial
      • Bash Apps
      • Python Apps
      • Spark Apps
        • Table Exporter
        • DX Spark Submit Utility
      • HTTPS Apps
        • Isolated Browsing for HTTPS Apps
      • Transitioning from Applets to Apps
      • Third Party and Community Apps
        • Community App Guidelines
        • Third Party App Style Guide
        • Third Party App Publishing Checklist
      • App Metadata
      • App Permissions
      • App Execution Environment
        • Connecting to Jobs
      • Dependency Management
        • Asset Build Process
        • Docker Images
        • Python package installation in Ubuntu 24.04 AEE
      • Job Identity Tokens for Access to Clouds and Third-Party Services
      • Enabling Web Application Users to Log In with DNAnexus Credentials
      • Types of Errors
    • Workflows
      • Importing Workflows
      • Introduction to Building Workflows
      • Building and Running Workflows
      • Workflow Build Process
      • Versioning and Publishing Global Workflows
      • Workflow Metadata
    • Ingesting Data
      • Molecular Expression Assay Loader
        • Common Errors
        • Example Usage
        • Example Input
      • Data Model Loader
        • Data Ingestion Key Steps
        • Ingestion Data Types
        • Data Files Used by the Data Model Loader
        • Troubleshooting
      • Dataset Extender
        • Using Dataset Extender
    • Dataset Management
      • Rebase Cohorts and Dashboards
      • Assay Dataset Merger
      • Clinical Dataset Merger
    • Apollo Datasets
      • Dataset Versions
      • Cohorts
    • Creating Custom Viewers
    • Client Libraries
      • Support for Python 3
    • Walkthroughs
      • Creating a Mixed Phenotypic Assay Dataset
      • Guide for Ingesting a Simple Four Table Dataset
    • DNAnexus API
      • Entity IDs
      • Protocols
      • Authentication
      • Regions
      • Nonces
      • Users
      • Organizations
      • OIDC Clients
      • Data Containers
        • Folders and Deletion
        • Cloning
        • Project API Methods
        • Project Permissions and Sharing
      • Data Object Lifecycle
        • Types
        • Object Details
        • Visibility
      • Data Object Metadata
        • Name
        • Properties
        • Tags
      • Data Object Classes
        • Records
        • Files
        • Databases
        • Drives
        • DBClusters
      • Running Analyses
        • I/O and Run Specifications
        • Instance Types
        • Job Input and Output
        • Applets and Entry Points
        • Apps
        • Workflows and Analyses
        • Global Workflows
        • Containers for Execution
      • Search
      • System Methods
      • Directory of API Methods
      • DNAnexus Service Limits
  • Administrator
    • Billing
    • Org Management
    • Single Sign-On
    • Audit Trail
    • Integrating with External Services
    • Portal Setup
    • GxP
      • Controlled Tool Access (allowed executables)
  • Science Corner
    • Scientific Guides
      • Somatic Small Variant and CNV Discovery Workflow Walkthrough
      • SAIGE GWAS Walkthrough
      • LocusZoom DNAnexus App
      • Human Reference Genomes
    • Using Hail to Analyze Genomic Data
    • Open-Source Tools by DNAnexus Scientists
    • Using IGV Locally with DNAnexus
  • Downloads
  • FAQs
    • EOL Documentation
      • Python 3 Support and Python 2 End of Life (EOL)
    • Automating Analysis Workflow
    • Backups of Customer Data
    • Developing Apps and Applets
    • Importing Data
    • Platform Uptime
    • Legal and Compliance
    • Sharing and Collaboration
    • Product Version Numbering
  • Release Notes
  • Technical Support
  • Legal
Powered by GitBook

Copyright 2025 DNAnexus

On this page
  • Supported Field Types
  • Date
  • Datetime
  • Float
  • Integer
  • Integer Categorical
  • String
  • String Categorical

Was this helpful?

Export as PDF
  1. Developer
  2. Ingesting Data
  3. Data Model Loader

Ingestion Data Types

Last updated 1 year ago

Was this helpful?

An Apollo license is required to use Data Model Loader on the DNAnexus Platform. Org approval may also be required. for more information.

Supported Field Types

Data Model Loader support a number of field types during ingestion of raw files. The following field types are supported with the outlined configurations. Note that during ingestion, all values in a field must conform to the type format supported and indicated. This includes special values used to indicate "Sparse" values.

For multi-select fields, the field in the raw data csv would be entered as "<value 1>|<value 2>|<value n>" with a "|" delimiter for entries where multiple values selected. Note that not all entries require multiple entries for a field to be treated as multi-select. The "value n", part of the multi-select must be non-null / non-empty.

Date

A date (i.e. timepoint with day granularity) without special values (other than NULL). An example is Date of Birth

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

date

The following formats are supported for Date

  • yyyy

  • yyyy-[m]m

  • yyyy-[m]m-[d]d

Date Sparse

A date with a few special values (other than NULL). An example is Date of Diagnosis where a date of "1900-01-01" indicates "Forgot to ask question".

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

date

<provided>

yes

Datetime

A datetime without special values (other than NULL). An example is datetime of hospital admission. Datetimes are stored in the system as UTC.

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

datetime

The following formats are supported for Datetime

  • yyyy

  • yyyy-[m]m

  • yyyy-[m]m-[d]d

  • yyyy-[m]m-[d]d [h]h:[m]m:[s]s.[ms][ms][ms][us][us][us]

  • yyyy-[m]m-[d]d [h]h:[m]m:[s]s.[ms][ms][ms][us][us][us]Z

  • yyyy-[m]m-[d]d [h]h:[m]m:[s]s.[ms][ms][ms][us][us][us]-[h]h:[m]m

  • yyyy-[m]m-[d]d [h]h:[m]m:[s]s.[ms][ms][ms][us][us][us]+[h]h:[m]m

  • yyyy-[m]m-[d]dT[h]h:[m]m:[s]s.[ms][ms][ms][us][us][us]

  • yyyy-[m]m-[d]dT[h]h:[m]m:[s]s.[ms][ms][ms][us][us][us]Z

  • yyyy-[m]m-[d]dT[h]h:[m]m:[s]s.[ms][ms][ms][us][us][us]-[h]h:[m]m

  • yyyy-[m]m-[d]dT[h]h:[m]m:[s]s.[ms][ms][ms][us][us][us]+[h]h:[m]m

Datetime Sparse

A datetime (i.e. timepoint with microsecond granularity) with a few special values (other than NULL). An example is Datetime of Treatment where a date of "1900-01-01 01:00" indicates "NA".

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

datetime

<provided>

yes

Float

A double-precision floating point measurement without special values (other than NULL). An example is Weight.

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

float

The following formats are supported for Float

  • #.#

  • #.#E#

  • -#.#E#

Float Sparse

A double-precision floating point measurement with a few special values (other than NULL). An example is Blood Glucose Level where a value of "-1.0" indicates "Read Failure".

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

float

<provided>

yes

Integer

An integer measurement without special values (other than NULL). An example is Age.

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

integer

The following formats are supported for Integer

  • #

Integer Sparse

An integer measurement with a few special values (other than NULL). An example is Cups of Coffee Consumed where a value of "-1" indicates "Prefer not to answer".

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

integer

<provided>

yes

Integer Categorical

A single-choice value (string) from a controlled vocabulary of possible options (or NULL), originally encoded as integer. An example is Have you traveled in the last 30 days? where a value of "1" means "Yes" and a value of 0 means "No"

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

integer

<provided>

Integer Categorical Hierarchical

A single-choice value (string) from a controlled vocabulary of possible options (or NULL) that are organized in a hierarchy, originally encoded as integer. An example is Job Code At Visit where an integer of "12" means "VP of Operations" which is a child of "Corporate Managers And Senior Officials".

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

integer

<provided>

<provided for child values>

Integer Categorical Multi-select

A multiple-choice value (string) from a controlled vocabulary of possible options (or NULL), originally encoded as integer. An example is Patient Ethnic Background where 0 means "African", 1 means "Caucasian", 2 means "Asian"... etc, and a patient may be part of one or many races.

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

integer

<provided>

yes

Integer Categorical Multi-select Hierarchical

A multiple-choice value (string) from a controlled vocabulary of possible options (or NULL) that are organized in a hierarchy, originally encoded as integer. An example is Cancer Codes Self Reported where 0 means "Parotid Gland Cancer", 2 means "Other Salivary Gland Cancer" and both have a parent of 3 "Salivary Gland Cancer" .. etc, and a patient may have one or more cancer codes entered.

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

integer

<provided>

yes

<provided for child values>

String

A free-form string without special values (other than NULL). An example is UUID or Special Instructions.

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

string

The following formats are supported for String

  • any string

  • for quote escaping use "" (e.g. use <"the ""quote"" phrase"> to get <the "quote" phrase>)

String Categorical

A single-choice value (string) from a controlled vocabulary of possible options (or NULL), originally encoded as string. An example is T-Shirt Size where "S" means "Small"

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

string

<provided>

String Categorical Hierarchical

A single-choice value (string) from a controlled vocabulary of possible options (or NULL) that are organized in a hierarchy, originally encoded as string. An example is State of Residency where a value of "CA" means "California" and a value of "OR" means "Oregon" and both values have a parent of "US" that means "United States of America".

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

string

<provided>

<provided for child values>

String Categorical Multi-select

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

string

<provided>

yes

String Categorical Multi-Select Hierarchical

A multiple-choice value (string) from a controlled vocabulary of possible options (or NULL) that are organized in a hierarchy, originally encoded as string. An example is Secondary Diagnosis where an entry may have one or more values encoded to match .

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

string

<provided>

yes

<provided for child values>

String Categorical Sparse

A single-choice value (string) from a controlled vocabulary of possible options (originally encoded as string) or a write-in value (or NULL). Most values are expected to be from the controlled vocabulary. An example is Prescribed Medication where each entry is a single item from a list of RXNORM medications where "RX5640" means "Ibuprofen", etc. but a value may be written in if the medication is not available as an option.

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

string

<provided>

yes

String Categorical Sparse Hierarchical

A single-choice value (string) from a controlled vocabulary of possible options that are organized in a hierarchy (originally encoded as string) or a write-in value (or NULL). Most values are expected to be from the controlled vocabulary. An example is Previous Diagnostic Codes ICD-10 where the code "D03" has meaning "Melanoma in situ", and the code "D03.0" has meaning "D03.0 Melanoma in situ of lip", and "D03.0" is hierarchically situated under "D03", or any other free-form string that is not part of ICD10 like "Other trauma".

Ingestion files are configured as follows:

type

coding_name

is_sparse_coding

is_multi_select

(coding.csv) parent_code

string

<provided>

yes

<provided for child values>

The Integer Categorical fields supports the same formats as the field.

String Categorical supports all of the same formats as the field

A multiple-choice value (string) from a controlled vocabulary of possible options (or NULL), originally encoded as string. An example is Primary Diagnosis where values are encoded to match .

Contact DNAnexus Sales
ICD10 diagnostic codes
Integer
String