Sources

This section provides information about each source currently supported by the DSL (version cris-2.0.0) in its default configuration, listing each field available for that source with details about the field value type and whether it is a multi-value field. The page also lists the fields included in each fieldset available for a given source.

Note

See also Deprecations History section for a list of deprecated fields.

Publications

Publications Fields

Fields be used to perform searches on the source they belong to.

Field

Type

Multi?

Filter?

Facet?

Description

altmetric

Literal: float

Altmetric attention score.

altmetric_id

Literal: integer

AltMetric Publication ID

authors

Literal: json

Ordered list of authors names and their affiliations, as they appear in the original publication. The list can include researcher and organization identifiers, when available (note: in order to search for disambiguated authors, use the in researchers syntax).

book_doi

Literal: identifier

The DOI of the book a chapter belongs to (note: this field is available only for chapters).

book_series_title

Literal: text

The title of the book series book, belong to.

book_title

Literal: text

The title of the book a chapter belongs to (note: this field is available only for chapters).

category_bra

Entity: categories

Broad Research Areas

category_for

Entity: categories

ANZSRC Fields of Research classification

category_hra

Entity: categories

Health Research Areas

category_hrcs_hc

Entity: categories

HRCS - Health Categories

category_hrcs_rac

Entity: categories

HRCS – Research Activity Codes

category_rcdc

Entity: categories

Research, Condition, and Disease Categorization

category_sdg

Entity: categories

SDG - Sustainable Development Goals

concepts

Literal: text

Concepts describing the main topics of a publication (note: automatically derived from the publication text using machine learning).

date

Literal: date

The publication date of a document, eg “2018-01-01” (note: dates can sometimes be incomplete and include only the month or the year).

date_inserted

Literal: date

Date when the record was inserted into Dimensions (note: this field does not support exact match on the data, only range filters e.g. <= or `>=’).

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 (note: does not support emptiness filters).

funder_countries

Entity: countries

The country of the organisation funding this publication.

funders

Entity: orgs

The GRID organisation funding this publication.

id

Literal: identifier

Dimensions publication ID.

issn

Literal: string

International Standard Serial Number

issue

Literal: string

The issue number of a publication.

journal

Entity: journals

The journal a publication belongs to.

journal_lists

Literal: label

Independent grouping of journals outside of Dimensions, e.g. ‘ERA 2015’ or ‘Norwegian register level 1’.

linkout

Literal: text

Original URL for a publication full text.

mesh_terms

Literal: label

Medical Subject Heading terms as used in PubMed.

open_access_categories

Entity: open_access

Open Access categories for publications. See below for more examples. 1

pages

Literal: string

The pages of the publication, as they would appear in a citation record.

pmcid

Literal: identifier

PubMed Central ID.

pmid

Literal: identifier

PubMed ID.

proceedings_title

Literal: text

Title of the conference proceedings volume associated to a publication.

publisher

Literal: label

Name of the publisher as a string.

recent_citations

Literal: integer

Number of citations received in the last two years. Does not support emptiness filters

reference_ids

Literal: identifier

Dimensions publication ID for publications in the references list, i.e. outgoing citations (see also: Cross Source Links section).

relative_citation_ratio

Literal: float

Relative citation performance of an article when compared to others in its area of research (note: does not support emptiness filters).

research_org_cities

Entity: cities

City of the organisations authors are affiliated to, expressed as GeoNames ID and name.

research_org_countries

Entity: countries

Country of the organisations authors are affiliated to, identified using GeoNames codes (note: this field supports count: count).

research_org_country_names

Literal: string

Country name of the organisations authors are affiliated to, as a string.

research_org_names

Literal: string

Names of organizations authors are affiliated to.

research_org_state_codes

Entity: states

State of the organisations authors are affiliated to, expressed as GeoNames codes (ISO‌-3166-2).

research_org_state_names

Literal: string

State name of the organisations authors are affiliated to, as a string.

research_orgs

Entity: orgs

GRID organisations associated to a publication. Identifiers are automatically extracted from author affiliations text, so they can be missing in some cases (note: this field supports count: count).

researchers

Entity: researchers

Researcher IDs matched to the publication’s authors list. (note: this returns only the disambiguated authors of a publication; in order to get the full authors list, the field author_affiliations should be used). This field supports count: count.

supporting_grant_ids

Literal: identifier

Grants supporting a publication, returned as a list of dimensions grants IDs (see also: Cross Source Links section).

times_cited

Literal: count

Number of citations (note: does not support emptiness filters).

title

Literal: text

Title of a publication.

type

Literal: label

Publication type (one of: article, chapter, proceeding, monograph, preprint or book). Valid values: article book chapter monograph preprint proceeding

volume

Literal: string

Publication volume.

year

Literal: integer

The year of publication (note: when the date field is available, this is equal to the year part of the full date).

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

Fieldsets are used to specify fields groups in the context of a return statement.

Fieldset

Fields

extras

altmetric date doi funders pmcid pmid reference_ids 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

categories

category_bra category_for category_hra category_hrcs_hc category_hrcs_rac category_rcdc

book

book_doi book_series_title book_title

basics

authors id issue journal pages title type volume year

Publications Search Indexes

Search indexes are used to perform full-text searches on the source they belong to. The default search index, which is used if none other is specified, is full_search.

Search index

Description

title_only

Search for keywords in title only.

title_abstract_only

Search for keywords in title and abstract only.

full_data_exact

Search for keywords in the full text of a publication. This search index is not normalized(stemmed), so useful for searching exact terminology, such as gene names, chemical compounds etc.

full_data

Search for keywords in the full text of a publication.

concepts

Search for keywords in the concepts list for this publication.

authors

Search for name and surname combinations in the authors list of this publication (note: see the researchers search section for more details).

Grants

Grants Fields

Fields be used to perform searches on the source they belong to.

Field

Type

Multi?

Filter?

Facet?

Description

abstract

Literal: text

Abstract or summary from a grant proposal.

active_year

Literal: integer

List of active years for a grant.

category_bra

Entity: categories

Broad Research Areas

category_for

Entity: categories

ANZSRC Fields of Research classification

category_hra

Entity: categories

Health Research Areas

category_hrcs_hc

Entity: categories

HRCS - Health Categories .

category_hrcs_rac

Entity: categories

HRCS – Research Activity Codes .

category_rcdc

Entity: categories

Research, Condition, and Disease Categorization .

category_sdg

Entity: categories

SDG - Sustainable Development Goals

concepts

Literal: text

Concepts describing the main topics of a grant (note: automatically derived from the grant text using machine learning).

date_inserted

Literal: date

Date when the record was inserted into Dimensions (note: this field does not support exact match on the data, only range filters e.g. <= or >=).

end_date

Literal: date

Date when the grant ends.

funder_countries

Entity: countries

The country linked to the organisation funding the grant, expressed as GeoNames codes.

funders

Entity: orgs

The organisation funding the grant. This is normally a GRID organisation, but in very few cases a Dimensions funder ID is used.

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

Name of funding organisation.

funding_usd

Literal: financial

Funding amount awarded in USD.

grant_number

Literal: identifier

Grant identifier, as provided by the source (e.g., funder, aggregator) the grant was derived from.

id

Literal: identifier

Dimensions grant ID.

investigator_details

Literal: json

Additional details about investigators, including affiliations and roles e.g. ‘PI’ or ‘Co-PI’ (note: if the investigator has a Dimensions researcher ID, that is returned as well).

language

Literal: label

Grant original language, as ISO 639-1 language codes.

linkout

Literal: text

Original URL for the grant.

original_title

Literal: text

Title of the grant in its original language.

research_org_cities

Entity: cities

City of the research organisations receiving the grant, expressed as GeoNames id and name.

research_org_countries

Entity: countries

Country of the research organisations receiving the grant, expressed as GeoNames code and name.

research_org_names

Literal: string

Names of organizations investigators are affiliated to.

research_org_state_codes

Entity: states

State of the organisations receiving the grant, expressed as GeoNames codes (ISO‌-3166-2).

research_orgs

Entity: orgs

GRID organisations receiving the grant (note: identifiers are automatically extracted from the source text and can be missing in some cases).

researchers

Entity: researchers

Dimensions researchers IDs associated to the grant.

resulting_publication_ids

Literal: identifier

Publication IDs for publications that resulted from the grant. Warning: This data may be 2-3 months behind the publications source data.

start_date

Literal: date

Date when the grant starts, in the format ‘YYYY-MM-DD’.

start_year

Literal: integer

Year when the grant starts.

title

Literal: text

Title of the grant in English (if the grant language is not English, this field contains a translation of the title).

title_language

Literal: label

ISO 639-1 language code for the original grant title.

Grants Fieldsets

Fieldsets are used to specify fields groups in the context of a return statement.

Fieldset

Fields

extras

funder_countries funding_org_acronym funding_org_city linkout research_orgs researchers

categories

category_bra category_for category_hra category_hrcs_hc category_hrcs_rac category_rcdc

basics

active_year end_date funders funding_org_name grant_number id language original_title start_date start_year title title_language

Grants Search Indexes

Search indexes are used to perform full-text searches on the source they belong to. The default search index, which is used if none other is specified, is full_search.

Search index

Description

title_only

Search for keywords in title only

title_abstract_only

Search for keywords in title and abstract only

investigators

Search for name and surname combinations in the investigators list of this grant (note: see the researchers search section for more details).

full_data

Search for keywords in full document

concepts

Search for keywords in the concepts list for this grant.

Patents

Patents Fields

Fields be used to perform searches on the source they belong to.

Field

Type

Multi?

Filter?

Facet?

Description

abstract

Literal: text

Abstract or description of the patent.

additional_filters

Literal: string

Additional filters describing the patents, e.g. whether it’s about a ‘Research Organisation’, or it is part of the ‘Orange Book’.

assignee_cities

Entity: cities

City of the assignees of the patent, expressed as GeoNames ID and name.

assignee_countries

Entity: countries

Country of the assignees of the patent, expressed as GeoNames code and name.

assignee_names

Literal: string

Name of the GRID assignees of the patent.

assignee_state_codes

Entity: states

State of the assignee, expressed using GeoNames (ISO‌-3166-2) codes.

assignee_state_names

Literal: label

State name of the assignee, as a string.

assignees

Entity: orgs

GRID organisations who own or have owned the rights of a patent (note: this is a combination of current_assignees and original_assigness fields).

associated_grant_ids

Literal: identifier

Dimensions IDs of the grants associated to the patent (see also: Cross Source Links section).

category_bra

Entity: categories

Broad Research Areas

category_for

Entity: categories

ANZSRC Fields of Research classification

category_hra

Entity: categories

Health Research Areas

category_hrcs_hc

Entity: categories

HRCS - Health Categories

category_hrcs_rac

Entity: categories

HRCS – Research Activity Codes

category_rcdc

Entity: categories

Research, Condition, and Disease Categorization

cited_by_ids

Literal: identifier

Dimensions IDs of the patents that cite this patent (see also: Cross Source Links section).

cpc

Literal: label

Cooperative Patent Classification Categorization.

current_assignee_names

Literal: string

Names of the GRID organisations currently holding the patent.

current_assignees

Entity: orgs

GRID organisations currenlty owning the patent.

date

Literal: date

Date when the patent was filed.

date_inserted

Literal: date

Date when the record was inserted into Dimensions (note: this field does not support exact match on the data, only range filters e.g. <= or >=).

expiration_date

Literal: date

Date when the patent expires.

filing_status

Literal: string

Filing Status of the patent e.g. ‘Application’ or ‘Grant’.

funder_groups

Entity: org_groups

Group of the organization that funded the patent.

funders

Entity: orgs

GRID organisations funding the patent.

granted_date

Literal: date

The date on which the official body grants the patent.

granted_year

Literal: integer

The year on which the official body grants the patent.

id

Literal: identifier

Dimensions patent ID

inventor_names

Literal: string

Names of the people who invented the patent.

ipcr

Literal: label

International Patent Classification Reform Categorization.

jurisdiction

Literal: string

The jurisdiction where the patent was granted, e.g. ‘US’, ‘DE’, ‘EP’…

legal_status

Literal: string

The legal status of the patent, e.g. ‘Granted’, ‘Active’, ‘Abandoned’ etc..

original_assignee_names

Literal: string

Name of the GRID organisation that first owned the patent.

original_assignees

Entity: orgs

GRID organisations that first owned the patent.

priority_date

Literal: date

The earliest filing date in a family of patent applications.

priority_year

Literal: integer

The filing year of the earliest application of which priority is claimed.

publication_date

Literal: date

Date of publication of a patent.

publication_ids

Literal: identifier

Dimensions IDs of the publications related to this patent (see also: Cross Source Links section).

publication_year

Literal: integer

Year of publication of a patent.

reference_ids

Literal: identifier

Dimensions IDs of the patents which are cited by this patent (see also: Cross Source Links section).

times_cited

Literal: count

The number of times the patent has been cited by other patents.

title

Literal: text

The title of the patent.

year

Literal: integer

The year the patent was filed.

Patents Fieldsets

Fieldsets are used to specify fields groups in the context of a return statement.

Fieldset

Fields

extras

cpc date expiration_date ipcr legal_status priority_date

categories

category_bra category_for category_hra category_hrcs_hc category_hrcs_rac category_rcdc

basics

assignee_names assignees filing_status granted_year id inventor_names publication_date times_cited title year

Patents Search Indexes

Search indexes are used to perform full-text searches on the source they belong to. The default search index, which is used if none other is specified, is full_search.

Search index

Description

title_only

Search for keywords in title only.

title_abstract_only

Search for keywords in title and abstract only.

inventors

Search for inventors

full_data

Search for keywords in full patent.

Clinical Trials

Clinical Trials Fields

Fields be used to perform searches on the source they belong to.

Field

Type

Multi?

Filter?

Facet?

Description

abstract

Literal: text

Abstract or description of the clinical trial.

active_years

Literal: integer

List of active years for a clinical trial.

associated_grant_ids

Literal: identifier

Dimensions IDs of the grants associated to the clinical trial (see also: Cross Source Links section).

category_bra

Entity: categories

Broad Research Areas

category_for

Entity: categories

ANZSRC Fields of Research classification

category_hra

Entity: categories

Health Research Areas

category_hrcs_hc

Entity: categories

HRCS - Health Categories

category_hrcs_rac

Entity: categories

HRCS – Research Activity Codes

category_icrp_cso

Entity: categories

ICRP Common Scientific Outline

category_icrp_ct

Entity: categories

ICRP Cancer Types

category_rcdc

Entity: categories

Research, Condition, and Disease Categorization

conditions

Literal: string

List of medical conditions names, e.g. ‘Breast cancer’ or ‘Obesity’.

date

Literal: date

Start date of a clinical trial.

date_inserted

Literal: date

Date when the record was inserted into Dimensions (note: this field does not support exact match on the data, only range filters e.g. <= or `>=’).

funder_countries

Entity: countries

The country group the funding organisations.

funder_groups

Entity: org_groups

The organisation group the funding organisations.

funders

Entity: orgs

GRID funding organisations that are involved with the clinical trial.

gender

Literal: string

The gender of the clinical trial subjects e.g. ‘Male’, ‘Female’ or ‘All’.

id

Literal: identifier

Dimensions clinical trial ID

investigator_details

Literal: json

Additional details about investigators, including affiliations and roles.

linkout

Literal: text

Original URL for the clinical trial.

organizations

Entity: orgs

GRID organizations involved, e.g. as sponsors or collaborators.

phase

Literal: string

Phase of the clinical trial, as a string.

publication_ids

Literal: identifier

Dimensions IDs of the publications related to this clinical trial (see also: Cross Source Links section).

registry

Literal: string

The platform where the clinical trial has been registered, e.g. ‘ClinicalTrials.gov’ or ‘EU-CTR’.

researchers

Entity: researchers

Dimensions researchers IDs associated to the clinical trial.

title

Literal: text

The title of the clinical trial.

Clinical Trials Fieldsets

Fieldsets are used to specify fields groups in the context of a return statement.

Fieldset

Fields

extras

abstract conditions gender linkout phase registry

categories

category_bra category_for category_hra category_hrcs_hc category_hrcs_rac category_rcdc

basics

active_years id investigator_details title

Clinical Trials Search Indexes

Search indexes are used to perform full-text searches on the source they belong to. The default search index, which is used if none other is specified, is full_search.

Search index

Description

title_only

Search for keywords in title only

title_abstract_only

Search for keywords in title and abstract only

investigators

Search for keywords in the investigators fields of a clinical trial.

full_data

Search for keywords in full clinical trial document.

Policy Documents

Policy Documents Fields

Fields be used to perform searches on the source they belong to.

Field

Type

Multi?

Filter?

Facet?

Description

category_bra

Entity: categories

Broad Research Areas

category_hra

Entity: categories

Health Research Areas

category_hrcs_hc

Entity: categories

HRCS - Health Categories

category_hrcs_rac

Entity: categories

HRCS – Research Activity Codes

category_rcdc

Entity: categories

Research, Condition, and Disease Categorization

date_inserted

Literal: date

Date when the record was inserted into Dimensions (note: this field does not support exact match on the data, only range filters e.g. <= or >=).

id

Literal: identifier

Dimensions policy document ID

linkout

Literal: text

Original URL for the policy document.

publication_ids

Literal: identifier

Dimensions IDs of the publications related to this policy document (see also: Cross Source Links section).

publisher_org

Entity: orgs

GRID organization publishing the policy document.

publisher_org_city

Entity: cities

City of the organization publishing the policy document.

publisher_org_country

Entity: countries

Country of the organization publishing the policy document.

publisher_org_state

Entity: states

State of the organization publishing the policy document.

title

Literal: string

Title of the policy document.

year

Literal: integer

Year of publication of the policy document.

Policy Documents Fieldsets

Fieldsets are used to specify fields groups in the context of a return statement.

Fieldset

Fields

categories

category_bra category_hra category_hrcs_hc category_hrcs_rac category_rcdc

basics

id linkout publisher_org publisher_org_city publisher_org_country publisher_org_state title year

Policy Documents Search Indexes

Search indexes are used to perform full-text searches on the source they belong to. The default search index, which is used if none other is specified, is full_search.

Search index

Description

title_only

Search for keywords in title only.

full_data

Search for keywords in full policy document.

Researchers

Researchers Fields

Fields be used to perform searches on the source they belong to.

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 year the researcher was awarded a grant.

first_name

Literal: string

First Name.

first_publication_year

Literal: integer

id

Literal: identifier

Dimensions researcher ID.

last_grant_year

Literal: integer

Last year the researcher was awarded a grant.

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 the redirect field for further information on invalid researcher IDs.

orcid_id

Literal: string

ORCID ID.

redirect

Literal: identifier

Indicates status of a researcher ID marked as obsolete. 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: count

Total grants count.

total_publications

Literal: count

Total publications count.

Researchers Fieldsets

Fieldsets are used to specify fields groups in the context of a return statement.

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