Supported data

This page lists each source and entity currently supported by the DSL (version 1.16.0) in its default configuration, listing each field available for that source/entity with details about the field value type, including whether it may be used as a facet and whether it is a multi-value field. The page also lists the fields included in each fieldset available for a given source/entity, and each aggregation indicator available for each source.

Sources

Publications

Publications Fields

Field Type Multi? Filter? Facet? Description
altmetric Literal: float     Altmetric attention score. Does not support emptiness filters
altmetric_id Literal: integer     AltMetric Publication ID
author_affiliations Literal: json     List of JSON lists of researchers’ first and last names and affiliations
book_doi Literal: identifier      
book_series_title Literal: text        
book_title Literal: text        
date Literal: date      
date_inserted Literal: date     Date when publication was inserted into Dimensions
doi Literal: identifier     Digital object identifier
field_citation_ratio Literal: float     Relative citation performance of article when compared to similarly aged articles in its area of research. Does not support emptiness filters
FOR Entity: categories ANZSRC Fields of Research classification
FOR_first Entity: categories Division level FOR
funder_countries Entity: countries  
funders Entity: orgs  
HRCS_HC Entity: categories HRCS - Health Categories
HRCS_RAC Entity: categories HRCS – Research Activity Codes
id Literal: identifier     Dimensions publication id
issn Literal: string   International Standard Serial Number
issue Literal: string      
journal Entity: journals    
journal_lists Literal: string   Independent grouping of journals outside of Dimensions
linkout Literal: text       URL address
mesh_terms Literal: label Medical Subject Heading terms as used in PubMed.
open_access Literal: string   Open Access status for publication. Deprecated in favor of open_access_categories
open_access_categories Entity: open_access Open Access category for publication. Filtering on values is case sensitive. [1]
pages Literal: string      
pmcid Literal: identifier     PubMed Central ID
pmid Literal: identifier     PubMed ID
proceedings_title Literal: text       Title of a conference corresponding to documents that are type of “proceeding”
publisher Literal: label    
RCDC Entity: categories Research, Condition, and Disease Categorization
recent_citations Literal: integer     Number of citations received in the last two years. Does not support emptiness filters
references Literal: identifier   Dimensions publication id for documents referencing another document
relative_citation_ratio Literal: float     Relative citation performance of an article when compared to others in its area of research. Does not support emptiness filters
research_org_cities Entity: cities GeoNames id and name
research_org_countries Entity: countries Note: this field supports Filter functions: count
research_org_country_names Literal: string   GeoNames country name
research_org_state_codes Entity: states ISO‌-3166-2 code and name
research_org_state_names Literal: string   GeoNames state name
research_orgs Entity: orgs Note: this field supports Filter functions: count
researchers Entity: researchers Note: this field supports Filter functions: count
supporting_grant_ids Literal: identifier    
terms Literal: text     Extracted terms. See for "search term" regarding searching terms vs phrases
times_cited Literal: count     Number of citations. Does not support emptiness filters
title Literal: text        
type Literal: string     Publication type (article, chapter, proceeding, monograph, preprint or book)
volume Literal: string      
year Literal: integer    
[1]

Open Access category data for publications values:

  • oa_all: Article is freely available
  • gold_pure: Version Of Record (VOR) is free under an open licence from a full OA journal
  • gold_hybrid: Version Of Record (VOR) is free under an open licence in a paid-access journal
  • gold_bronze: Freely available on publisher page, but without an open licence
  • green_pub: Free copy of published version in an OA repository
  • green_acc: Free copy of accepted version in an OA repository
  • green_sub: Free copy of submitted version, or where version is unknown, in an OA repository
  • closed: No freely available copy has been identified

Publications Fieldsets

Fieldset Fields
extras altmetric date doi FOR funders open_access pmcid pmid references relative_citation_ratio research_org_cities research_org_countries research_org_country_names research_org_state_codes research_org_state_names research_orgs researchers times_cited
book book_doi book_series_title book_title
basics author_affiliations id issue journal pages title type volume year

Publications Indicators

Indicators are used in aggregate.

Indicator Description
recent_citations_total For a given article, in a given year, the number of citations accrued in the last two year period. Single value stored per document, year window rolls over in July.
rcr_avg Arithmetic mean of relative_citation_ratio
fcr_gavg Geometric mean of field_citation_ratio
count Total count
citations_total Aggregated number of citations
citations_median Median of citations
citations_avg Arithmetic mean of citations
altmetric_median Median Altmetric attention score

Publications Search Fields

Search field Description
title_only Search for keywords in title only
title_abstract_only Search for keywords in title and abstract only
terms Extracted terms for reviewer finding functionality
researchers Search for authors
full_data Search for keywords in full document
authors Search for authors

Grants

Grants Fields

Field Type Multi? Filter? Facet? Description
abstract Literal: text        
active_year Literal: integer  
date_inserted Literal: date     Date when publication was inserted into Dimensions
end_date Literal: date      
FOR Entity: categories ANZSRC Fields of Research classification
FOR_first Entity: categories Division level FOR
funder_countries Entity: countries GeoNames code and name
funders Entity: orgs  
funding_aud Literal: financial     Funding amount awarded in AUD
funding_cad Literal: financial     Funding amount awarded in CAD
funding_chf Literal: financial     Funding amount awarded in CHF
funding_currency Literal: label   Original funding currency
funding_eur Literal: financial     Funding amount awarded in EUR
funding_gbp Literal: financial     Funding amount awarded in GBP
funding_jpy Literal: financial     Funding amount awarded in JPY
funding_nzd Literal: financial     Funding amount awarded in NZD
funding_org_acronym Literal: label   Acronym for funding organisation
funding_org_city Literal: label   City name for funding organisation
funding_org_name Literal: label    
funding_usd Literal: financial     Funding amount awarded in USD
HRCS_HC Entity: categories HRCS - Health Categories
HRCS_RAC Entity: categories HRCS – Research Activity Codes
id Literal: identifier     Dimensions grant id
language Literal: label   ISO 639-1 language codes
linkout Literal: text       URL linked to grant
original_title Literal: text        
project_num Literal: identifier      
RCDC Entity: categories Research, Condition, and Disease Categorization
research_org_cities Entity: cities GeoNames id and name
research_org_countries Entity: countries GeoNames code and name
research_org_name Literal: label   Name for research organisation
research_org_state_codes Entity: states ISO‌-3166-2 code and name
research_orgs Entity: orgs  
researcher_details Literal: json       Additional details about researchers including affiliations and role
researchers Entity: researchers  
resulting_publication_ids Literal: identifier   Resulting Publication IDs. Deprecated, use publications field supporting_grant_ids instead
start_date Literal: date      
start_year Literal: integer    
title Literal: text        
title_language Literal: label   ISO 639-1 language code used in title

Grants Fieldsets

Fieldset Fields
extras funder_countries funding_org_acronym funding_org_city linkout research_org_name researchers
basics active_year end_date funders funding_org_name id language original_title project_num start_date start_year title title_language

Grants Indicators

Indicators are used in aggregate.

Indicator Description
funding  
count Total count

Grants Search Fields

Search field Description
title_only Search for keywords in title only
title_abstract_only Search for keywords in title and abstract only
researchers Search for authors
full_data Search for keywords in full document

Patents

Patents Fields

Field Type Multi? Filter? Facet? Description
abstract Literal: text        
additional_filters Literal: string    
assignee_cities Entity: cities GeoNames id and name
assignee_countries Entity: countries GeoNames code and name
assignee_names Literal: string    
assignee_state_codes Entity: states GeoNames code and name
assignee_state_names Literal: label GeoNames name
assignees Entity: orgs  
associated_grant_ids Literal: identifier    
cited_by_ids Literal: identifier   Patents which cite this patent
cpc Literal: identifier   Cooperative Patent Classification number for a patent
current_assignee_names Literal: string    
current_assignees Entity: orgs  
date Literal: date     Date when the patent was filed
date_inserted Literal: date     Date when publication was inserted into Dimensions
expiration_date Literal: date      
filed_date Literal: date     Deprecated in favor of filed_date
filed_year Literal: integer    
filing_status Literal: string      
FOR Entity: categories ANZSRC Fields of Research classification
FOR_first Entity: categories Division level FOR
funder_groups Entity: org_groups  
funders Entity: orgs  
granted_year Literal: integer    
HRCS_HC Entity: categories HRCS - Health Categories
HRCS_RAC Entity: categories HRCS – Research Activity Codes
id Literal: identifier     Dimensions patent id
inventor_names Literal: string      
ipcr Literal: identifier   International Patent Classification Reform number for a patent
jurisdiction Literal: string      
legal_status Literal: string      
original_assignee_names Literal: string    
original_assignees Entity: orgs  
priority_date Literal: date      
publication_date Literal: date      
publication_ids Literal: identifier   Related publication IDs
RCDC Entity: categories Research, Condition, and Disease Categorization
reference_ids Literal: identifier   Patents which are cited by this patent
status Literal: string     Deprecated in favor of legal_status
times_cited Literal: count      
title Literal: text        
year Literal: integer    

Patents Fieldsets

Fieldset Fields
extras cpc expiration_date filed_date ipcr priority_date status
basics assignee_names assignees filed_year filing_status granted_year id inventor_names publication_date times_cited title

Patents Indicators

Indicators are used in aggregate.

Indicator Description
count Total count

Patents Search Fields

Search field Description
title_only Search for keywords in title only
title_abstract_only Search for keywords in title and abstract only
full_data Search for keywords in full document

Clinical Trials

Clinical Trials Fields

Field Type Multi? Filter? Facet? Description
abstract Literal: text        
active_years Literal: integer  
associated_grant_ids Literal: identifier    
conditions Literal: string    
date Literal: date     Start date of a clinical trial
date_inserted Literal: date     Date when publication was inserted into Dimensions
FOR Entity: categories ANZSRC Fields of Research classification
FOR_first Entity: categories Division level FOR
funder_countries Entity: countries  
funder_groups Entity: org_groups  
funders Entity: orgs  
gender Literal: string      
HRCS_HC Entity: categories HRCS - Health Categories
HRCS_RAC Entity: categories HRCS – Research Activity Codes
id Literal: identifier     Dimensions clinical trial id
investigators Literal: json     JSON with names, titles, & roles (no ids) of involved researchers for display purposes
linkout Literal: text       URL linked to clinical trial
organizations Entity: orgs IDs of any organizations involved in any way, e.g. as sponsors or collaborators
phase Literal: string      
publication_ids Literal: identifier   Linked Publication IDs
RCDC Entity: categories Research, Condition, and Disease Categorization
registry Literal: string      
title Literal: text        

Clinical Trials Fieldsets

Fieldset Fields
extras abstract conditions gender linkout phase registry
basics active_years id investigators title

Clinical Trials Indicators

Indicators are used in aggregate.

Indicator Description
count Total count

Clinical Trials Search Fields

Search field Description
title_only Search for keywords in title only
title_abstract_only Search for keywords in title and abstract only
researchers Search for authors
full_data Search for keywords in full document

Policy Documents

Policy Documents Fields

Field Type Multi? Filter? Facet? Description
broad_research_areas Entity: categories  
city Entity: cities    
country Entity: countries    
date_inserted Literal: date     Date when policy document was inserted into Dimensions
FOR Entity: categories ANZSRC Fields of Research classification
FOR_first Entity: categories Division level FOR
grid_id Literal: string      
health_research_areas Entity: categories  
HRCS_HC Entity: categories HRCS - Health Categories
HRCS_RAC Entity: categories HRCS – Research Activity Codes
id Literal: identifier     Dimensions policy document id
linkout Literal: text        
publication_ids Literal: identifier   Referenced Publication IDs
RCDC Entity: categories Research, Condition, and Disease Categorization
source_name Literal: string      
state Entity: states    
title Literal: string      
year Literal: integer   Policy posted on year

Policy Documents Fieldsets

Fieldset Fields
categories broad_research_areas FOR FOR_first health_research_areas HRCS_HC HRCS_RAC RCDC
basics city country grid_id id linkout source_name state title year

Policy Documents Indicators

Indicators are used in aggregate.

Indicator Description
count Total count

Policy Documents Search Fields

Search field Description
title_only Search for keywords in title only
full_data Search for keywords in full document

Researchers

Researchers Fields

Field Type Multi? Filter? Facet? Description
current_research_org Entity: orgs   The most recent research organization linked to the researcher
first_grant_year Literal: integer    
first_name Literal: string     First Name
first_publication_year Literal: integer    
id Literal: identifier     Dimensions researcher id
last_grant_year Literal: integer    
last_name Literal: string     Last Name
last_publication_year Literal: integer    
obsolete Literal: integer     Indicates researcher ID status. 0 means that the researcher ID is still active, 1 means that the researcher ID is no longer valid. See redirect field for further information on invalid researcher IDs. Also see function check_researcher_ids in Functions and arguments.
orcid_id Literal: text     ORCID ID
redirect Literal: identifier   Indicates status of obsolete researcher ID. Empty means that the researcher ID was deleted. Otherwise ID provided means that is the new id into which the obsolete one was redirected. If multiple values are available, it means that the original researcher ID was split into multiple IDs.
research_orgs Entity: orgs All research organizations linked to the researcher
total_grants Literal: integer   Total grants count
total_publications Literal: integer   Total publications count

Researchers Fieldsets

Fieldset Fields
extras current_research_org first_grant_year first_publication_year last_grant_year last_publication_year total_grants total_publications
basics first_name id last_name orcid_id research_orgs

Researchers Indicators

Indicators are used in aggregate.

Indicator Description
count Total count

Entities

States

States Literal Fields

Field Literal Type Multi? Description
name string    
id identifier   Dimensions state id

States Fieldsets

Fieldset Fields
basics id name

Orgs

Orgs Literal Fields

Field Literal Type Multi? Description
name string    
id identifier   Dimensions organization id
country_name string    
acronym string    

Orgs Fieldsets

Fieldset Fields
basics acronym country_name id name

Org Groups

Org Groups Literal Fields

Field Literal Type Multi? Description
name string    
id identifier   Dimensions organization group id

Org Groups Fieldsets

Fieldset Fields
basics id name

Open Access

Open Access Literal Fields

Field Literal Type Multi? Description
name string    
id identifier    
description text    

Open Access Fieldsets

Fieldset Fields
basics description id name

Journals

Journals Literal Fields

Field Literal Type Multi? Description
title string    
id string   Dimensions journal id

Journals Fieldsets

Fieldset Fields
basics id title

Countries

Countries Literal Fields

Field Literal Type Multi? Description
name string    
id string   Dimensions city id

Countries Fieldsets

Fieldset Fields
basics id name

Cities

Cities Literal Fields

Field Literal Type Multi? Description
name string    
id identifier   Dimensions city id

Cities Fieldsets

Fieldset Fields
basics id name

Categories

Categories Literal Fields

Field Literal Type Multi? Description
name string    
id string   Dimensions category id

Categories Fieldsets

Fieldset Fields
basics id name

Literal Field Types

Field type Facetable? Description
boolean True/False value
count   Integer that represents an aggregated count, e.g. times a work has been cited
date   String that represents a precise date
financial   Float that represents a currency amount, e.g. funding amount in USD
float   Floating decimal point number
identifier   String that represents a unique identifier for a document, e.g. DOI
integer Whole number
label String that represents a label of an associated entity, e.g. country name
string   Short piece of text a few characters/words long, e.g. journal issue
text   Longer textual data, e.g. title or abstract. Fields of this type cannot be used in the filter part of query (where)
json   Fields of this type cannot be used in filters