Supported data

This page lists each source and entity currently supported by the DSL (version 1.14.1) 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.

The configuration described here is the default data configuration; for information on using other configurations.

Sources

Publications

Publications Literal Fields

Field Literal Type Multi? Description Filter functions
altmetric float   Altmetric attention score. Does not support emptiness filters  
author_affiliations json List of JSON lists of researchers’ first and last names and affiliations  
book_doi identifier      
book_series_title text      
book_title text      
date date      
date_inserted timestamp   Date when publication was inserted into Dimensions  
doi identifier   Digital object identifier  
field_citation_ratio float   Relative citation performance of article when compared to similarly aged articles in its area of research. Does not support emptiness filters  
id identifier   Dimensions publication id  
issn string International Standard Serial Number  
issue string      
journal_lists string Independent grouping of journals outside of Dimensions  
linkout text   URL address  
open_access string Open Access status for publication [1]  
pages string      
pmcid identifier   PubMed Central ID  
pmid identifier   PubMed ID  
proceedings_title text   Title of a conference corresponding to documents that are type of “proceeding”  
references identifier Dimensions publication id for documents referencing another document  
relative_citation_ratio float   Relative citation performance of an article when compared to others in its area of research. Does not support emptiness filters  
research_org_country_names string GeoNames country name  
supporting_grant_ids identifier    
times_cited count   Number of citations. Does not support emptiness filters  
title text      
type string   Publication type (article, chapter, proceeding, monograph or preprint)  
volume string      
[1]

Open Access field data for publications can make reference to information on the host location and the record version.

Open Access host location

Host location information can describes if the document is either hosted by the publisher or in an institutional repository.

  • Open access - publisher means the linked full-text version is served by the article’s publisher.
  • Open access - repository means the linked full-text version is served by an Open Access repository.

Record Version

Record version refers to the version of the content as defined by Unpaywall (see Unpaywall Data Format)

  • Open access - submitted means the linked full-text version is not yet peer-reviewed.
  • Open access - accepted means the linked full-text version is peer-reviewed, but lacks publisher-specific formatting.
  • Open access - published means the linked full-text version is the version of record.

Publications Facet Fields

These fields can be used to facet, together with the entity fields in the next section.

Field Literal Type Multi? Description Filter functions
mesh_terms label Medical Subject Heading terms as used in PubMed.  
publisher label      
recent_citations integer   Number of citations received in the last two years. Does not support emptiness filters  
research_org_state_names label GeoNames state name  
year integer      

Publications Entity Fields

Fields in this table may be used as facets as well.

Field Entity Type Multi? Description Filter functions
FOR categories ANZSRC Fields of Research classification  
FOR_first categories Division level FOR  
funder_countries countries    
funders orgs    
HRCS_HC categories HRCS - Health Categories  
HRCS_RAC categories HRCS – Research Activity Codes  
journal journals      
open_access_categories open_access Open Access category for publication. Filtering on values is case sensitive. [2]  
RCDC categories Research, Condition, and Disease Categorization  
research_org_cities cities GeoNames id and name  
research_org_countries countries   count
research_org_state_codes states GeoNames code and name  
research_orgs orgs   count
researchers researchers   count
[2]

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

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
researchers Search for authors
full_data Search for keywords in full document
authors Search for authors

Policy Documents

Policy Documents Literal Fields

Field Literal Type Multi? Description
grid_id string    
id identifier   Dimensions clinical trial id
linkout text    
publication_ids identifier Referenced Publication IDs
source_name string    
title string    

Policy Documents Facet Fields

These fields can be used to facet, together with the entity fields in the next section.

Field Literal Type Multi? Description
year integer   Policy posted on year

Policy Documents Entity Fields

Fields in this table may be used as facets as well.

Field Entity Type Multi? Description
broad_research_areas categories  
city cities    
country countries    
FOR categories ANZSRC Fields of Research classification
FOR_first categories Division level FOR
health_research_areas categories  
HRCS_HC categories HRCS - Health Categories
HRCS_RAC categories HRCS – Research Activity Codes
RCDC categories Research, Condition, and Disease Categorization
state states    

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

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

Patents

Patents Literal Fields

Field Literal Type Multi? Description
abstract text    
additional_filters string  
assignee_names string  
associated_grant_ids identifier  
cited_by_ids identifier Patents which cite this patent
cpc identifier Cooperative Patent Classification number for a patent
current_assignee_names string  
date timestamp   Date when the patent was filed
date_inserted timestamp   Date when publication was inserted into Dimensions
expiration_date timestamp    
filed_date timestamp   Deprecated in favor of filed_date
filing_status string    
id identifier   Dimensions patent id
inventor_names string    
ipcr identifier International Patent Classification Reform number for a patent
jurisdiction string    
legal_status string    
original_assignee_names string  
priority_date timestamp    
publication_date timestamp    
publication_ids identifier Related publication IDs
reference_ids identifier Patents which are cited by this patent
status string   Deprecated in favor of legal_status
times_cited count    
title text    

Patents Facet Fields

These fields can be used to facet, together with the entity fields in the next section.

Field Literal Type Multi? Description
assignee_state_names label GeoNames name
filed_year integer    
granted_year integer    
year integer    

Patents Entity Fields

Fields in this table may be used as facets as well.

Field Entity Type Multi? Description
assignee_cities cities GeoNames id and name
assignee_countries countries GeoNames code and name
assignee_state_codes states GeoNames code and name
assignees orgs  
current_assignees orgs  
FOR categories ANZSRC Fields of Research classification
FOR_first categories Division level FOR
funder_groups org_groups  
funders orgs  
HRCS_HC categories HRCS - Health Categories
HRCS_RAC categories HRCS – Research Activity Codes
original_assignees orgs  
RCDC categories Research, Condition, and Disease Categorization

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

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

Grants

Grants Literal Fields

Field Literal Type Multi? Description
abstract text    
date_inserted timestamp   Date when publication was inserted into Dimensions
end_date timestamp    
funding_aud financial   Funding amount awarded in AUD
funding_cad financial   Funding amount awarded in CAD
funding_chf financial   Funding amount awarded in CHF
funding_eur financial   Funding amount awarded in EUR
funding_gbp financial   Funding amount awarded in GBP
funding_jpy financial   Funding amount awarded in JPY
funding_usd financial   Funding amount awarded in USD
id identifier   Dimensions grant id
linkout text   URL linked to grant
original_title text    
project_num identifier    
researcher_details json   Additional details about researchers including affiliations and role
resulting_publication_ids identifier Resulting Publication IDs. Deprecated, use publications field supporting_grant_ids instead
start_date timestamp    
title text    

Grants Facet Fields

These fields can be used to facet, together with the entity fields in the next section.

Field Literal Type Multi? Description
active_year integer  
funding_org_acronym label   Acronym for funding organisation
funding_org_city label   City name for funding organisation
funding_org_name label    
language label   ISO 639-1 language codes
research_org_name label   Name for research organisation
start_year integer    
title_language label   ISO 639-1 language code used in title

Grants Entity Fields

Fields in this table may be used as facets as well.

Field Entity Type Multi? Description
FOR categories ANZSRC Fields of Research classification
FOR_first categories Division level FOR
funder_countries countries GeoNames code and name
funders orgs  
HRCS_HC categories HRCS - Health Categories
HRCS_RAC categories HRCS – Research Activity Codes
RCDC categories Research, Condition, and Disease Categorization
research_org_cities cities GeoNames id and name
research_org_countries countries GeoNames code and name
research_org_state_codes states GeoNames code and name
research_orgs orgs  
researchers researchers  

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

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

Clinical Trials

Clinical Trials Literal Fields

Field Literal Type Multi? Description
abstract text    
associated_grant_ids identifier  
conditions string  
date timestamp    
date_inserted timestamp   Date when publication was inserted into Dimensions
gender string    
id identifier   Dimensions clinical trial id
investigators json JSON with names, titles, & roles (no ids) of involved researchers for display purposes
linkout text   URL linked to clinical trial
phase string    
publication_ids identifier Linked Publication IDs
registry string    
title text    

Clinical Trials Facet Fields

These fields can be used to facet, together with the entity fields in the next section.

Field Literal Type Multi? Description
active_years integer  

Clinical Trials Entity Fields

Fields in this table may be used as facets as well.

Field Entity Type Multi? Description
FOR categories ANZSRC Fields of Research classification
FOR_first categories Division level FOR
funder_countries countries  
funder_groups org_groups  
funders orgs  
HRCS_HC categories HRCS - Health Categories
HRCS_RAC categories HRCS – Research Activity Codes
organizations orgs IDs of any organizations involved in any way, e.g. as sponsors or collaborators
RCDC categories Research, Condition, and Disease Categorization

Clinical Trials Fieldsets

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

Clinical Trials Indicators

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

Entities

States

States Literal Fields

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

States Fieldsets

Fieldset Fields
basics id name

Researchers

Researchers Literal Fields

Field Literal Type Multi? Description
research_orgs identifier  
orcid_id text  
last_name string    
id identifier   Dimensions researcher id
first_name string    

Researchers Fieldsets

Fieldset Fields
basics first_name id last_name orcid_id research_orgs

Publications Entity

Publications Entity Literal Fields

Field Literal Type Multi? Description
pmid identifier   PubMed ID
pmcid identifier   PubMed Central ID
id identifier   Dimensions publication id
doi identifier   Digital object identifier

Publications Entity Fieldsets

Fieldset Fields
basics doi id pmcid pmid

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)