Release Notes and Deprecations

Versions History

Version 1.31.0 — 2021, May, Week of 31st

  1. New field clinical_trial_ids in Publications

  2. Fieldset all is now deprecated

  3. New field journal_title_raw in Publications

Version 1.30.0 –— 2021, March, Week of 15th

  1. New fields arxiv_id, subtitles, date_print, date_online and source_title in Publications

  2. Field open_access_categories in Publications is deprecated in favor of open_access_categories_v2

  3. Wildcard searches no longer allow prefix wildcards. See Wildcard Searches for more details.

  4. New field altmetric in Clinical Trials

  5. New sources Source Titles and Reports

Version 1.29.0 –— 2021, January, Week of 18th

  1. New fields authors_count and date_original in publications and count filter function enabled for authors field. See also the Dealing with hyper-authorship section

  2. New element _copyright being returned for all queries.

  3. New element _version being returned for all queries. This includes information from the describe version command.

  4. New fields inventor_details and family_id in patents

  5. New field repository_id in datasets

  6. Improved naming of fields for consistency, including:

  • investigator_details in grants and clinical trials was deprecated in favor of the new investigators field

  • inventor_details in patents was deprecated in favor of the new inventors field

Version 1.28.0 –— 2020, September, Week of 14th

  1. Improved quality of concepts in grants

  2. New field concepts_scores in grants

  3. New field clinical_trial_ids in publications

  4. Expert Identification now supports identification using grants as a source

  5. New fields abstract and acknowledgements in publications

  6. Field authors in affiliations now may contain an additional key raw_affiliations with raw affiliations data, when available

Version 1.27.0 — 2020, August, Week of 17th

  1. Searching in multiple search indexes in a single query

  2. Unnesting multi-value entity fields: now supported for JSON fields, such as authors or concepts_scores as well

  3. New field publications in patents, clinical_trials and policy_documents

  4. New field associated_publication in datasets

  5. New field referenced_pubs in publications

  6. New field research_org_names in grants

  7. New fields status and redirect in organizations

  8. New field dimensions_url in all sources, pointing records to the Dimensions web application

Version 1.26.0 — 2020, July, Week of 6th

  1. Expert Identification

  2. Returning complex calculations using result function expressions

  3. Unnesting multi-value entity fields

  4. New field funder_countries in patents - currently available only for US patents

  5. New field ror_ids in organizations

  6. New fields nuts_level3_code and nuts_level3_name in organizations

  7. New field category_sdg in grants

  8. New field mesh_terms in clinical trials

  9. New field category_sdg in datasets

  10. Field publication_ids in datasets is now deprecated and should not be used anymore

  11. Field license in datasets deprecated in favor of new fields license_name and license_url

Version 1.25.0 — 2020, May, Week of 25th

  1. Improved quality of concepts in publications

  2. New field concepts_scores in publications

  3. New optional parameter return_scores in function identify_concepts

  4. Function check_researchers_id was deprecated, instead, please follow method descibed in the Obsolete researchers section.

Version 1.24.0 — 2020, May, Week of 11th

  1. API Connector for Google Sheets

  2. New field category_sdg in publications

  3. New field research_org_names in publications containing names of research organizations

  4. Field assignee_state_names in patents is now deprecated

  5. New categorization of organizations using Nomenclature of Territorial Units for Statistics (NUTS) codes of the European Union - fields nuts_level1_code, nuts_level1_name, nuts_level2_code, nuts_level2_name,

  6. New field category_uoa in grants - Units of Assessment

  7. New element _version being returned for all queries. This includes information from describe version command

  8. Function classify now supports two new classification systems: UOA and SDG

  9. New command descibe service grid which returns the version of the GRID API used by the Dimensions API

Version 1.23.0 — 2020, February, Week of 17th

  1. New source data_sets

  2. Field title_language in grants is now deprecated in favor of language_title

  3. Field category_ua in publications is now deprecated in favor of category_uoa

  4. New field acronym in clinical_trials

  5. New field brief_title in clinical_trials

  6. Field organizations in clinical_trials is now deprecated in favor of research_orgs

Version 1.22.0 — 2020, February, Week of 3rd

  1. New field category_icrp_ct in policy documents - ICRP Cancer Types

  2. New field category_for in policy documents. Should be used instead of FOR and FOR_first

  3. New field resulting_publication_doi - for preprints, the DOIs of the resulting full publications.

  4. Patents.funder_groups and clinical_trials.funder_groups have been deprecated as this functionality will be delivered via the new ‘My Groups’ feature of the Dimensions Analytics webapp.

  5. New field nih_ppid in researchers source - The PI Profile ID (i.e., ppid) is a Researcher ID from the US National Institute of Health (NIH).

  6. New field foa_number in grants source - The funding opportunity announcement (FOA) number, where available e.g. for grants from the US National Institute of Health (NIH) or from the National Science Foundation (NSF).

  7. New field researchers in patents.

  8. New metadata command: describe service grid that returns the version of a GRID service used by extract_affiliations function

Version 1.21.1 — 2019, November, Week of 9th

  1. Returning null values for fields with no value now must be turned on explicitly using set return_all_keys before the actual query.

Version 1.21.0 — 2019, November, Week of 25th

  1. New function extract_affiliations

  2. Faceting now enabled on journal_list field in publications

  3. Faceting now enabled on jurisdiction field in patents

  4. Entity organizations promoted to a full-fledged source, which now contains includes all fields available in GRID

  5. New field category_ua in publications - Units of Assessment

  6. New field category_icrp_ct in publications, grants, patents and clinical trials - ICRP Cancer Types

  7. New field category_icrp_cso in publications, grants, patents, clinical trials and policy documents - ICRP Common Scientific Outline

  8. New field category_for in grants and clinical trials, patents, which deprecates FOR and FOR_first

  9. The DSL now returns fields with a null value if the value is missing, as opposed to previously omitting the field in the output

  10. Rationalized literal field types to 5 in total: date, float, integer, string and json

Version 1.20.0 — 2019, September, Week of 23rd

  1. Allowed filtering in researchers source by orcid_id field

  2. Added flag for corresponding authors in publications

Version 1.19.0 — 2019, August, Week of 26th

  1. New indicator altmetric_avg in publications

  2. New field granted_date in patents

  3. Enabled faceting on cpc and ipcr fields in patents

  4. New search field inventors in patents

  5. New field authors in publications, should be used instead of deprecated author_affiliations

Version 1.18.0 — 2019, August, Week of 4th

  1. New field category_for in publications. Should be used instead of FOR and FOR_first

  2. New field grant_number in grants. Should be used instead of project_num

  3. New search field full_data_exact in publications. This field provides a non-normalized(stemmed) search index, useful for searching for exact terminology such as gene names, chemical compounds, etc.

  4. Function extract_terms deprecated in favor of extract_concepts.

  5. New field researchers in clinical_trials.

  6. Category fields renamed, as following: RCDC -> category_rcdc, HRCS_RAC -> category_hrcs_rac, HRCS_RC -> category_hrcs_hc, HRA -> category_hra, BRA -> category_bra. These fields are now available accross all relevant sources: publications, grants, patents, clinical_trials and policy_documents. Old fields are still usable, altough marked as deprecated and will be removed in the future.

Version 1.17.0 — 2019, May, Week of 27th

  1. New field and search field concepts in publications and grants. Should be used instead of terms field/search field

  2. New field reference_ids in publications. Should be used instead of references

  3. New field publication_year in patents

  4. New field publisher_org, publisher_org_city, publisher_org_state, publisher_org_country in policy_documents

  5. New field investigator_details in clinical_trials. Should be used instead of researcher_details search field

  6. New field investigator_details in grants. Should be used instead of researcher_details search field

  7. New search field authors in publications. Should be used instead of researchers search field

  8. New search field investigators in grants. Should be used instead of researchers search field

  9. New search field inventors in patents. Should be used instead of researchers search field

  10. New search field investigators in clinical_trials. Should be used instead of researchers search field

  11. Enabled faceting on field type in publications

  12. Disabled faceting on fields total_grants and total_publications in researchers

  13. Fixed issues related to cited_by_ids in patents

  14. Fixed issues related to not returning some researchers from the researchers source

  15. Deprecating complex queries where the number of results of a sub-query is too large, and hence it gets truncated. Please see Frequently Asked Questions for more info. A warning is issued, but in future versions an exception will be thrown

Version 1.16.0 — 2019, April, Week of 22nd

  1. Deprecated ability to facet on field recent_citations in publications

  2. Deprecated ability to facet on field obsolete in researchers

  3. Deprecated ability to facet on field researcher_org_state_names in publications

  4. Deprecated ability to filter on JSON fields, including author_affiliations in publications and researcher_details in grants

  5. New field date_inserted in policy_documents

  6. New field funding_currency and funding_nzd in grants

Version 1.15.0 — 2019, March, Week of 25th

  1. New source: researchers

  2. Metadata API

  3. New function extract_terms() in Functions Syntax

  4. New field and search field terms in publications

  5. Enhanced support for full-text queries, including support for wildcard and proximity search. See for "search term"

Version 1.14.1 — 2019, March, Week of 4th

  1. Fixed search for complicated boolean phrases

  2. Fixed equals or equals or greater than filter for field date in publications

  3. Field status in patents is deprecated in favor of legal_status

  4. Field filed_date in patents is deprecated in favor of date

  5. Field resulting_publication_ids in grants is now deprecated.

Version 1.14.0 — 2019, February, Week of 11th

  1. publications have new fields: referenced_pubs, terms

  2. grants have new fields: researcher_details, terms

  3. Field open_access in publications is deprecated in favor of open_access_categories. It will be renamed back to open_access at some point in the future.

Version 1.13.0 — 2019, January, Week of 28th

  1. Escaping special characters in full text query; for "search term"

  2. publications have new fields: open_access_categories

  3. clinical_trials now support researchers search and emptiness filters

  4. grants source now supports researcher search

  5. New function: classify for classification of abstracts: Functions Syntax

  6. clinical_trials has new field: date_inserted

Version 1.12.0 — 2019, January, Week of 14th

  1. patents now support emptiness filters

  2. publications have new fields: linkout, publisher

  3. Functions Syntax

  4. mesh_terms in publications now supports case insensitive filtering

  5. Escaping special characters in full text query; for "search term". This syntax becomes mandatory as of next release

Version 1.11.0 — 2018, December, Week of 10th

  1. Ability to sort by relevance

  2. patents have a new field: date_inserted

  3. search publications in authors is now deprecated in favour of search publications in researchers

Version 1.10.0 — 2018, November, Week of 12th

  1. patents have a new field: FOR_first

  2. patents and grants sources now supports title_only search

  3. publications have a new field: proceedings_title

Version 1.9.0 — 2018, October, Week of 1st

  1. grants and policy documents now support emptiness filters

  2. Sorting now accepts asc or desc to alternate the sorting order

  3. New field date_inserted in grants, which indicates a date when publication has been inserted into Dimensions records

Version 1.8.0 — 2018, September, Week of 17th

  1. New field date_inserted in publications, which indicates a date when publication has been inserted into Dimensions records

  2. New source policy_documents

  3. Disabled filtering support for field researchers.orcid_id. Instead publications can be searched using search publications for "<orcid>"

  4. Disabled faceting support for field research_org_country_names in publications

  5. Expanded open_access values for publications content.

Version 1.7.0 — 2018, August, Week of 20th

  1. Support for title_only search in clinical_trials

  2. Support for count(researchers) in publications source

  3. Removed deprecated field funding_amount from grants source. Use funding_usd instead

  4. New fields: in patents: publication_ids

  5. New fields: in publications: recent_citations, field_citation_ratio, mesh_terms

Version 1.6.0 — 2018, July, Week of 30th

  1. Increased limit of returned facets to 1000. Disabled skip support for faceting results and introduced limit to skip for documents of 50000.

  2. New fields: in publications: journal_lists

  3. New fields: in grants: resulting_publication_ids

  4. New fields: in clinical_trials: publication_ids

Version 1.5.0 — 2018 Jun, Week of 25th

  1. Organization name is now case insensitive. where research_orgs.name ~ "michigan" will produce same results as when searching for uppercase “Michigan”

  2. Searching patents and returning all fieldset could fail previously, due to internal error. This is now fixed

  3. ORCID ID is now returned for publication researchers field, if the ID is available

  4. Field author_names is removed from publications source. Use author_affiliations field instead

Version 1.4.0 — 2018 Jun, Week of 11th

  1. Support for authors search field for publications, see section in [search index]. Field author_names is now deprecated and will be removed in the next release

  2. Initial support for interlinking between entities using IDs

  3. New fields for clinical trials: funders, funder_countries, funder_groups

  4. Enhanced open_access field for publications, see the description of the fields

  5. Added funding in different currencies to grants. Field funding_amount is now deprecated in favour of funding_usd

  6. Possibility to search for phrases, not just keywords and to combine them using boolean operators. See updated section for "search term"

  7. Added support for count on some fields, specifically: 1) count(research_orgs) in publications, and 2) count(research_org_countries) in publications

Version 1.3.0 — 2018 May, Week of 7th

  1. Return _stats with paging information in the results

  2. Consolidated publication_date and date fields for publications into just date. For grants, start_date and date have been consolidated into start_date

  3. Support for <field> is empty and <field> is not empty filters (see Emptiness filters is empty). Currently supported by publications only.

Version 1.2.2 — 2018-04-09

  1. Internal optimizations and bug fixes

Version 1.1.1 — 2018-03-21

  1. Added fields for publications FOR_first, RCDC, HRCS_RAC, HRCS_HC

Version 1.0.0 — 2018-03-01

  1. First public release

  2. Added support for search <source> [in full_data|text_abstract_only] [for …]

Deprecations History

This section lists fields and search fields that have been deprecated and should not be used.

Warning

This fields will be supported in versions 1.x and removed in the next major release. To ensure full compatibility with the upcoming major release, it is recommend to stop using deprecated fields as soon as possible.

Deprecated Fields

Source

Field

Deprecation Note

Publications

author_affiliations

Deprecated in favor of: authors

Publications

category_ua

Deprecated in favor of: category_uoa

Publications

FOR

Deprecated in favor of: category_for

Publications

FOR_first

Deprecated in favor of: category_for

Publications

HRCS_HC

Deprecated in favor of: category_hrcs_hc

Publications

HRCS_RAC

Deprecated in favor of: category_hrcs_rac

Publications

open_access

Deprecated in favor of: open_access_categories

Publications

open_access_categories

Deprecated in favor of: open_access_categories_v2

Publications

RCDC

Deprecated in favor of: category_rcdc

Publications

references

Deprecated in favor of: reference_ids

Publications

terms

Deprecated in favor of: concepts

Grants

FOR

Deprecated in favor of: category_for

Grants

FOR_first

Deprecated in favor of: category_for

Grants

HRCS_HC

Deprecated in favor of: category_hrcs_hc

Grants

HRCS_RAC

Deprecated in favor of: category_hrcs_rac

Grants

investigator_details

Deprecated in favor of: investigators

Grants

project_num

Deprecated in favor of: grant_number

Grants

RCDC

Deprecated in favor of: category_rcdc

Grants

research_org_name

Deprecated in favor of: research_orgs

Grants

researcher_details

Deprecated in favor of: investigator_details

Grants

resulting_publication_ids

Deprecated: use the Publications field supporting_grant_ids instead (see also: Grants Links section).

Grants

terms

Deprecated in favor of: concepts

Grants

title_language

Deprecated in favor of: language_title

Patents

assignee_state_names

None

Patents

filed_date

Deprecated in favor of: date

Patents

filed_year

Deprecated in favor of: year

Patents

FOR

Deprecated in favor of: category_for

Patents

FOR_first

Deprecated in favor of: category_for

Patents

funder_groups

Deprecated as this functionality will be delivered via the new “My Groups” feature of the Dimensions Analytics webapp

Patents

HRCS_HC

Deprecated in favor of: category_hrcs_hc

Patents

HRCS_RAC

Deprecated in favor of: category_hrcs_rac

Patents

RCDC

Deprecated in favor of: category_rcdc

Patents

status

Deprecated in favor of: legal_status

Clinical Trials

FOR

Deprecated in favor of: category_for

Clinical Trials

FOR_first

Deprecated in favor of: category_for

Clinical Trials

funder_groups

Deprecated as this functionality will be delivered via the new “My Groups” feature of the Dimensions Analytics webapp

Clinical Trials

HRCS_HC

Deprecated in favor of: category_hrcs_hc

Clinical Trials

HRCS_RAC

Deprecated in favor of: category_hrcs_rac

Clinical Trials

investigator_details

Deprecated in favor of: investigators

Clinical Trials

organizations

Deprecated in favor of: research_orgs

Clinical Trials

RCDC

Deprecated in favor of: category_rcdc

Policy Documents

broad_research_areas

Deprecated in favor of: category_bra

Policy Documents

city

Deprecated in favor of: publisher_org_city

Policy Documents

country

Deprecated in favor of: publisher_org_country

Policy Documents

FOR

Deprecated in favor of: category_for

Policy Documents

FOR_first

Deprecated in favor of: category_for

Policy Documents

grid_id

Deprecated in favor of: publisher_org

Policy Documents

health_research_areas

Deprecated in favor of: category_hra

Policy Documents

HRCS_HC

Deprecated in favor of: category_hrcs_hc

Policy Documents

HRCS_RAC

Deprecated in favor of: category_hrcs_rac

Policy Documents

RCDC

Deprecated in favor of: category_rcdc

Policy Documents

source_name

Deprecated in favor of: publisher_org

Policy Documents

state

Deprecated in favor of: publisher_org_state

Datasets

license

Deprecated in favor of: license_name

Datasets

publication_ids

None

Partially Deprecated Fields

On the following fields only certain features are deprecated (e.g. filtering or faceting).

Source

Field

Deprecated Features

Publications

recent_citations

facet

Publications

research_org_state_names

facet

Researchers

obsolete

facet

Deprecated Search Indexes

Source

Search Index

Deprecation Note

Publications

terms

Deprecated in favor of: concepts

Publications

researchers

Deprecated in favor of: authors

Grants

terms

Deprecated in favor of: concepts

Grants

researchers

Deprecated in favor of: investigators

Clinical Trials

researchers

Deprecated in favor of: investigators

Deprecated Functions

Function

Deprecation Note

check_researcher_ids

Deprecated in favor of: True

extract_terms

Deprecated in favor of: extract_concepts