diff --git a/docs/data-model/entities/community.md b/docs/data-model/entities/community.md
index 3c1eda5..1c20efb 100644
--- a/docs/data-model/entities/community.md
+++ b/docs/data-model/entities/community.md
@@ -4,5 +4,19 @@ sidebar_position: 6
# Community (Initiative)
-TODO
+Research communities and research initiatives are intended as groups of people with a common research intent and can be of two types: research initiatives or research communities:
+
+* Research initiatives are intended to capture a view of the information space that is "research impact"-oriented, i.e. all products generated due to my research initiative;
+* Research communities the latter “research activity” oriented, i.e. all products that may be of interest or related to my research initiative.
+
+For example, the organizations supporting a research infrastructure fall in the first category, while the researchers involved in a discipline fall in the second.
+
+## The `Community` object
+
+### id
+_Type: String • Cardinality: ONE_
+
+Main entity identifier, created according to the [OpenAIRE entity identifier and PID mapping policy](entity-identifiers).
+
+TODO
\ No newline at end of file
diff --git a/docs/data-model/entities/data-source.md b/docs/data-model/entities/data-source.md
index 5bee910..8bf6dc0 100644
--- a/docs/data-model/entities/data-source.md
+++ b/docs/data-model/entities/data-source.md
@@ -16,7 +16,7 @@ OpenAIRE entity instances are created out of data collected from various data so
### id
_Type: String • Cardinality: ONE_
-Main entity identifier, created according to [OpenAIRE_entity_identifier_and_PID_mapping_policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy).
+Main entity identifier, created according to the [OpenAIRE entity identifier and PID mapping policy](entity-identifiers).
### originalId
_Type: String • Cardinality: MANY_
diff --git a/docs/data-model/entities/entity-identifiers.md b/docs/data-model/entities/entity-identifiers.md
index 58ffa26..f6b86fa 100644
--- a/docs/data-model/entities/entity-identifiers.md
+++ b/docs/data-model/entities/entity-identifiers.md
@@ -4,5 +4,36 @@ sidebar_position: 8
# OpenAIRE entity identifier and PID mapping policy
-https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy
-TODO: include this here? it referenced by many other pages
\ No newline at end of file
+OpenAIRE assigns internal identifiers for each object it collects.
+By default, the internal identifier is generated as `sourcePrefix::md5(localId)` where:
+
+* `sourcePrefix` is a namespace prefix of 12 chars assigned to the data source at registration time
+* `localid` is the identifier assigned to the object by the data source
+
+After years of operation, we can say that:
+
+* `localId` are unstable
+* objects can disappear from sources
+* PIDs provided by sources that are not PID agencies (authoritative sources for a specific type of PID) are often wrong (e.g. pre-print with the DOI of the published version, DOIs with typos)
+
+Therefore, when the record is collected from an authoritative source:
+
+* the identity of the record is forged using the PID, like `pidTypePrefix::md5(lowercase(doi))`
+* the PID is added in a `pid` element of the data model
+
+When the record is collected from a source which is not authoritative for any type of PID:
+* the identity of the record is forged as usual using the local identifier
+* the PID, if available, is added as `alternateIdentifier`
+
+Currently, the following data sources are used as "PID authorities":
+
+| PID Type | Prefix (12 chars) | Authority |
+|---------- |------------------- |--------------------------------------- |
+| doi | `doi_________` | Crossref, Datacite, Zenodo |
+| pmc | `pmc_________` | Europe PubMed Central, PubMed Central |
+| pmid | `pmid________` | Europe PubMed Central, PubMed Central |
+| arXiv | `arXiv_______` | arXiv.org e-Print Archive |
+| handle | `handle______` | any repository |
+
+OpenAIRE also perform duplicate identification (see the [dedicated section for details](../../data-provision/deduplication/)).
+All duplicates are **merged** together in a **representative record** which must be assigned a dedicated OpenAIRE identifier (i.e. it cannot have the identifier of one of the aggregated record).
\ No newline at end of file
diff --git a/docs/data-model/entities/organization.md b/docs/data-model/entities/organization.md
index 1564998..7af09a7 100644
--- a/docs/data-model/entities/organization.md
+++ b/docs/data-model/entities/organization.md
@@ -14,7 +14,7 @@ Organizations include companies, research centers or institutions involved as pr
### id
_Type: String • Cardinality: ONE_
-Main entity identifier, created according to [OpenAIRE_entity_identifier_and_PID_mapping_policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy).
+Main entity identifier, created according to the [OpenAIRE entity identifier and PID mapping policy](entity-identifiers).
### legalshortname
_Type: String • Cardinality: ONE_
diff --git a/docs/data-model/entities/other.md b/docs/data-model/entities/other.md
index a0a5fa1..8523e9f 100644
--- a/docs/data-model/entities/other.md
+++ b/docs/data-model/entities/other.md
@@ -2,174 +2,169 @@
sidebar_position: 7
---
-# Other helper objects
+# Other component objects
-Here, we describe other helper objects that are used as part of the main graph entities.
+Here, we describe other component objects that are used as part of the main graph entities.
## AccessRight
-_Type: One of `{ gold, green, hybrid, bronze }` • Cardinality: ONE_
Subclass of [BestAccessRight](#bestaccessright), indicates information about rights held in and over the resource and the open Access Route.
### openAccessRoute
+_Type: One of `{ gold, green, hybrid, bronze }` • Cardinality: ONE_
Indicates the OpenAccess status. Values are set according to the [Unpaywall methodology](https://support.unpaywall.org/support/solutions/articles/44001777288-what-do-the-types-of-oa-status-green-gold-hybrid-and-bronze-mean-).
+```json
+"openAccessRoute": "gold"
+```
+
## AlternateIdentifier
Type used to represent the information associated to persistent identifiers associated to the result that have not been forged by an authority for that pid type. For example we collect metadata from an institutional repository that provides as identifier for the result also the doi.
-
- Example
-
-
-```json
- {
- "scheme" : "doi",
- "value" : "10.17182/hepdata.9959"
- }
-```
-
-
### scheme
_Type: String • Cardinality: ONE_
Vocabulary reference.
+```json
+"scheme": "doi"
+```
+
### value
_Type: String • Cardinality: ONE_
Value from the given scheme/vocabulary.
+```json
+"value": "10.1016/j.respol.2021.104226"
+```
+
## APC
Indicates the money spent to make a book or article available in Open Access. Sources for this information includes the OpenAPC initiative.
-
- Example
-
-
-```json
-{
- "currency" : "EU",
- "amount": "1000"
-}
-```
-
-
### currency
_Type: String • Cardinality: ONE_
The system of money in which the amount is expressed (Euro, USD, etc).
+```json
+"currency": "EU"
+```
+
### amount
_Type: String • Cardinality: ONE_
The quantity of money.
+```json
+"amount": "1000"
+```
+
## Author
Represents the result author.
-
- Example
-
-
-```json
-{
- "fullname":"Turunen, Heidi",
- "name":"Heidi",
- "surname":"Turunen",
- "rank":1,
- "pid":{
- "id":{
- "scheme":"orcid",
- "value":"0000-0001-7169-1177"
- },
- "provenance":{
- "provenance":"Harvested",
- "trust":"0.9"
- }
- }
-}
-```
-
-
### fullname
_Type: String • Cardinality: ONE_
Author's full name.
+```json
+"fullname": "Turunen, Heidi"
+```
+
### name
_Type: String • Cardinality: ONE_
Author's given name.
+```json
+"name": "Heidi"
+```
+
### surname
_Type: String • Cardinality: ONE_
Author's family name.
+```json
+"surname": "Turunen"
+```
+
### rank
_Type: String • Cardinality: ONE_
Author's order in the list of authors for the given result.
+```json
+"rank": 1
+```
+
### pid
_Type: [AuthorPid](#authorpid) • Cardinality: ONE_
Persistent identifier associated with this author.
+```json
+"pid": {
+ "id": {
+ "scheme": "orcid",
+ "value": "0000-0001-7169-1177"
+ },
+ "provenance" {
+ "provenance": "Harvested",
+ "trust": "0.9"
+ }
+}
+```
+
## AuthorPid
The author's persistent identifier.
-
- Example
-
-
-```json
-{
- "id":{
- "scheme":"orcid",
- "value":"0000-0001-7169-1177"
- },
- "provenance":{
- "provenance":"Inferred by OpenAIRE",
- "trust":"0.85"
- }
-}
-```
-
-
### id
_Type: [AuthorPidSchemaValue](#authorpidschemavalue) • Cardinality: ONE_
+```json
+"id": {
+ "scheme": "orcid",
+ "value": "0000-0001-7169-1177"
+}
+```
+
### provenance
_Type: [Provenance](#provenance-2) • Cardinality: ONE_
-## AuthorPidSchemaValue
-Type used to represent the scheme and value for the author's pid.
+The reason why the pid was associated to the author.
-
- Example
-
-
-```json
-{
- "scheme" : "orcid",
- "value" : "0000-1111-2222-3333"
+```json
+"provenance": {
+ "provenance": "Inferred by OpenAIRE",
+ "trust": "0.85"
}
```
-
+
+## AuthorPidSchemaValue
+Type used to represent the scheme and value for the author's pid.
### schema
_Type: String • Cardinality: ONE_
The author's pid scheme. OpenAIRE currently supports ORCID.
+```json
+"scheme": "orcid"
+```
+
### value
_Type: String • Cardinality: ONE_
-The author's pid value.
+The author's pid value in that scheme.
+
+```json
+"value": "0000-1111-2222-3333"
+```
## BestAccessRight
Indicates the most open access rights \*available among the result Instances.
@@ -178,50 +173,64 @@ Indicates the most open access rights \*available among the result Instances.
```
OPEN SOURCE > OPEN > EMBARGO (6MONTHS) > EMBARGO (12MONTHS) > RESTRICTED > CLOSED > UNKNOWN
```
-
- Example
-
-
-```json
-{
- "code":"c_16ec",
- "label":"RESTRICTED",
- "scheme":"http://vocabularies.coar-repositories.org/documentation/access_rights/"
-}
-```
-
-
-
### code
_Type: String • Cardinality: ONE_
-TODO
+
+COAR access mode code: http://vocabularies.coar-repositories.org/documentation/access_rights/.
+
+```json
+"code": "c_16ec"
+```
### label
_Type: String • Cardinality: ONE_
-TODO
+
+Label for the access mode.
+
+```json
+"label": "RESTRICTED"
+```
### scheme
_Type: String • Cardinality: ONE_
-TODO
+
+Scheme of reference for access right code. Currently, always set to COAR access rights vocabulary: http://vocabularies.coar-repositories.org/documentation/access_rights/.
+
+```json
+"scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
+```
## Container
This field has information about the conference or journal where the result has been presented or published.
### name
_Type: String • Cardinality: ONE_
+
Name of the journal or conference.
+```json
+"name": "Research Policy"
+```
+
### issnPrinted
_Type: String • Cardinality: ONE_
The journal printed issn.
+```json
+"issnPrinted": "0048-7333"
+```
+
### issnOnline
_Type: String • Cardinality: ONE_
The journal online issn.
+```json
+"issnOnline": "1873-7625"
+```
+
### issnLinking
_Type: String • Cardinality: ONE_
@@ -232,21 +241,37 @@ _Type: String • Cardinality: ONE_
The journal issue.
+```json
+"iss": "5"
+```
+
### sp
_Type: String • Cardinality: ONE_
The start page.
+```json
+"sp": "12"
+```
+
### ep
_Type: String • Cardinality: ONE_
The end page.
+```json
+"ep": "22"
+```
+
### vol
_Type: String • Cardinality: ONE_
The journal volume.
+```json
+"vol": "50"
+```
+
### edition
_Type: String • Cardinality: ONE_
@@ -257,71 +282,93 @@ _Type: String • Cardinality: ONE_
The place of the conference.
+```json
+"conferenceplace": "Padua, Italy"
+```
+
### conferencedate
_Type: String • Cardinality: ONE_
The date of the conference.
-
-## ControlledField
-TODO: similar to AlternateIdentifier and ResultPid?
-
-Generic type used to represent the information described by a scheme and a value in that scheme (i.e. pid).
-
-
- Example
-
-
-```json
-{
- "scheme" : "DOI",
- "value" : "10.5281/zenodo.4707307"
-}
+```json
+"conferencedate": "2022-09-22"
```
-
+## ControlledField
+
+
+Generic type used to represent the information described by a scheme and a value in that scheme (i.e. pid).
### scheme
_Type: String • Cardinality: ONE_
Vocabulary reference.
+```json
+"scheme": "DOI"
+```
+
### value
_Type: String • Cardinality: ONE_
Value from the given scheme/vocabulary.
+```json
+"value": "10.5281/zenodo.4707307"
+```
+
## Country
To represent the generic country code and label.
-
### code
_Type: String • Cardinality: ONE_
-The country code (i.e. IT).
-TODO: based on which list?
+ISO 3166-1 alpha-2 country code.
+
+```json
+"code" : "IT"
+```
### label
_Type: String • Cardinality: ONE_
-The country label (i.e. Italy).
-
+The country label.
+```json
+"label": "Italy"
+```
## GeoLocation
Represents the geolocation information.
### point
_Type: String • Cardinality: ONE_
-TODO
+
+A point with Latitude and Longitude.
+
+```json
+"point": "7.72486 50.1084"
+```
### box
_Type: String • Cardinality: ONE_
-TODO
+
+A specified bounding box defined by two longitudes (min and max) and two latitudes (min and max).
+
+
+```json
+"box": "18.569386 54.468973 18.066832 54.83707"
+```
### place
_Type: String • Cardinality: ONE_
-TODO
+
+The name of a specific place.
+
+```json
+"place": "Tübingen, Baden-Württemberg, Southern Germany"
+```
## Instance
An instance is one specific materialization or version of the result. For example, you can have one result with three instances as result of deduplication:
@@ -330,62 +377,97 @@ An instance is one specific materialization or version of the result. For exampl
* one is the post-print
* one is the published version
-Each instance is characterized by the properties described in the following table.
-
-
- Example
-
-
-```json
-{
- "accessright":{
- "code":"c_abf2",
- "label":"OPEN",
- "openAccessRoute":"gold",
- "scheme":"http://vocabularies.coar-repositories.org/documentation/access_rights/"
- },
- "alternateIdentifier":[],
- "license":"http://creativecommons.org/licenses/by-nc/4.0",
- "pid":[],
- "publicationdate":"2009-02-12",
- "refereed":"UNKNOWN",
- "type":"Article",
- "url":["https://periodicos2.uesb.br/index.php/folio/article/view/4296"]
-}
-```
-
-
+Each instance is characterized by the properties that follow.
### accessright
_Type: [AccessRight](#accessright) • Cardinality: ONE_
Maps [dc:rights](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/rights/), describes the access rights of the web resources relative to this instance.
+```json
+"accessright": {
+ "code": "c_abf2",
+ "label": "OPEN",
+ "openAccessRoute": "gold",
+ "scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
+}
+```
+
### alternateIdentifier
_Type: [AlternateIdentifier](#alternateidentifier) • Cardinality: MANY_
All the identifiers associated to the result other than the authoritative ones.
+```json
+"alternateIdentifier": [
+ {
+ "scheme": "doi",
+ "value": "10.1016/j.respol.2021.104226"
+ },
+ ...
+]
+```
+
### articleprocessingcharge
_Type: [APC](#apc) • Cardinality: ONE_
The money spent to make this book or article available in Open Access. Source for this information is the OpenAPC initiative.
+```json
+"articleprocessingcharge": {
+ "currency": "EUR",
+ "amount": "1000"
+}
+```
+
### license
_Type: String • Cardinality: ONE_
The license URL.
+```json
+"license": "http://creativecommons.org/licenses/by-nc/4.0"
+```
+
+### measures
+_Type: [Measure](#measure) • Cardinality: MANY_
+
+The measures computed for this instance (e.g. those provided by [BIP! Finder](https://bip.imsi.athenarc.gr/)).
+
+```json
+"measures": [
+ {
+ "key": "influence",
+ "value": "6.45335454246e-09"
+ },
+ ...
+]
+```
+
### pid
_Type: [ResultPid](#resultpid) • Cardinality: MANY_
-The set of persistent identifiers associated to this instance that have been collected from an authority for the pid type (i.e. Crossref/Datacite for doi). See [OpenAIRE_entity_identifier_and_PID_mapping_policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy) for more information.
+The set of persistent identifiers associated to this instance that have been collected from an authority for the pid type (i.e. Crossref/Datacite for doi). See the [OpenAIRE entity identifier and PID mapping policy](entity-identifiers) for more information.
+
+```json
+"pid": [
+ {
+ "scheme": "pmc",
+ "value": "PMC8024784"
+ },
+ ...
+]
+```
### publicationdate
_Type: String • Cardinality: ONE_
The publication date of the research product.
+```json
+"publicationdate": "2009-02-12"
+```
+
### refereed
_Type: String • Cardinality: ONE_
@@ -399,214 +481,199 @@ based on guidelines covers the vocabularies
* [DRIVE guidelines 2.0 - info:eu-repo/semantic](https://wiki.surfnet.nl/download/attachments/10851536/DRIVER_Guidelines_v2_Final_2008-11-13.pdf) (OpenAIRE v1.0 till v3.0 - Literature)
* [COAR Vocabulary v2.0 and v3.0](https://vocabularies.coar-repositories.org/resource_types/) (OpenAIRE v4 - Inst.+Them.)
+```json
+"refereed": "UNKNOWN"
+```
+
### type
_Type: String • Cardinality: ONE_
The specific sub-type of this instance (see https://api.openaire.eu/vocabularies/dnet:result_typologies following the links)
+
+```json
+"type": "Article"
+```
+
### url
_Type: String • Cardinality: MANY_
URLs to the instance. They may link to the actual full-text or to the landing page at the hosting source.
+```json
+"url": [
+ "https://periodicos2.uesb.br/index.php/folio/article/view/4296",
+ ...
+]
+```
+
## Language
Represents information for the language of the result
### code
_Type: String • Cardinality: ONE_
-Alpha-3/ISO 639-2 code of the language.
+Alpha-3/ISO 639-2 code of the language. Values controlled by the [dnet:languages vocabulary](https://api.openaire.eu/vocabularies/dnet:languages).
+
+```json
+"code": "eng"
+```
### label
_Type: String • Cardinality: ONE_
-Language label in English
+Language label in English.
+
+```json
+"label": "English"
+```
+
+## Measure
+A measure computed for this instance (e.g. those provided by [BIP! Finder](https://bip.imsi.athenarc.gr/))
+
+### key
+_Type: String • Cardinality: ONE_
+
+The specified measure. Currently supported one of: `{ influence, influence_alt, popularity, popularity_alt, impulse, cc }` (see [the dedicated page](../../data-provision/enrichment/impact-scores) for more details).
+
+```json
+"key": "influence"
+```
+
+### value
+_Type: String • Cardinality: ONE_
+
+```json
+"value": "6.45335454246e-09"
+```
+
+The value for that measure.
## OrganizationPid
The schema and value for identifiers of the organization.
-
- Example
-
-
-```json
-{
- "scheme" : "GRID",
- "value" : "grid.7119.e"
-}
-```
-
-
-
### scheme
_Type: String • Cardinality: ONE_
Vocabulary reference (i.e. isni).
+```json
+"scheme" : "GRID"
+```
+
### value
_Type: String • Cardinality: ONE_
Value from the given scheme/vocabulary (i.e. 0000000090326370).
-## Provenance
-Indicates the process that produced (or provided) the information, and the trust associated to the information.
-
-
- Example
-
-
-```json
-[
- {
- "provenance":"Harvested",
- "trust":"0.9"
- },
- {
- "provenance":"Inferred by OpenAIRE",
- "trust":"0.875"
- },
- {
- "provenance":"Linked by user",
- "trust":"0.8"
- }
-]
+```json
+"value" : "grid.7119.e"
```
-
+## Provenance
+Indicates the process that produced (or provided) the information, and the trust associated to the information.
### provenance
_Type: String • Cardinality: ONE_
Provenance term from the vocabulary [dnet:provenanceActions](https://api.openaire.eu/vocabularies/dnet:provenanceActions).
+```json
+"provenance": "Harvested"
+```
+
### trust
_Type: String • Cardinality: ONE_
Trust, expressed as a number in the range [0-1].
+```json
+"trust": "0.9"
+```
+
## ResultCountry
It is for the country associated to the result.
It is a subclass of [Country](#country) and extends it with provenance information.
-
- Example
-
-
-```json
-{
- "code" : "IT",
- "label": "Italy",
- "provenance" : {
- "provenance": "inferred by OpenAIRE",
- "trust": "0.85"
- }
-}
-```
-
-
-
### provenance
_Type: [Provenance](#provenance-2) • Cardinality: ONE_
Indicates the reason why this country is associated to this result.
+```json
+"provenance" : {
+ "provenance": "inferred by OpenAIRE",
+ "trust": "0.85"
+}
+```
+
## ResultPid
Type used to represent the information associated to persistent identifiers for the result that have been forged by an authority for that pid type.
-Seems to be similar to the AlternateIdentifier. What is the difference?
-
-
- Example
-
-
-```json
-{
- "scheme" : "doi",
- "value" : "10.21511/bbs.13(3).2018.13"
-}
-```
-
+
### scheme
_Type: String • Cardinality: ONE_
-Vocabulary reference.
+The scheme of the persistent identifier for the result (i.e. doi). If the pid is here it means the information for the pid has been collected from an authority for that pid type (i.e. Crossref/Datacite for doi). The set of authoritative pid is: `doi` when collected from Crossref or Datacite, `pmid` when collected from EuroPubmed, `arxiv` when collected from arXiv, `handle` from the repositories.
+
+```json
+"scheme": "doi"
+```
### value
_Type: String • Cardinality: ONE_
-Value from the given scheme/vocabulary.
+The value expressed in the scheme (i.e. 10.1000/182).
+
+```json
+"value": "10.21511/bbs.13(3).2018.13"
+```
## Subject
Represents keywords associated to the result.
-
- Example
-
-
-```json
-[
- {
- "subject":{
- "scheme": "acm",
- "value": "GeneralLiterature_MISCELLANEOUS"
- },
- "provenance": {
- "provenance": "Inferred by OpenAIRE",
- "trust": "0.891"
- }
- },
- {
- "provenance":{
- "provenance":"Harvested",
- "trust":"0.9"
- },
- "subject":{
- "scheme":"keyword",
- "value":"SVOC"
- }
- }
-]
-```
-
-
### subject
_Type: [SubjectSchemeValue](#subjectschemevalue) • Cardinality: ONE_
Contains the subject term: subject type (keyword, MeSH, etc) and the subject term (medicine, chemistry, etc.).
+```json
+"subject": {
+ "scheme":"keyword",
+ "value":"SVOC"
+}
+```
+
### provenance
_Type: [Provenance](#provenance-2) • Cardinality: ONE_
Contains provenance information for the subject term.
+```json
+"provenance": {
+ "provenance":"Harvested",
+ "trust":"0.9"
+}
+```
+
## SubjectSchemeValue
Subject classification against a vocabulary
-
- Example
-
-
-```json
-[
- {
- "scheme" : "keyword",
- "value" : "pyrolysis-oil"
- },
- {
- "value":"food and beverages",
- "scheme":"mesheuropmc"
- }
-]
-```
-
-
### scheme
_Type: String • Cardinality: ONE_
OpenAIRE subject classification scheme (https://api.openaire.eu/vocabularies/dnet:subject_classification_typologies).
+```json
+"scheme" : "keyword"
+```
+
### value
_Type: String • Cardinality: ONE_
The value for the subject in the selected scheme. When the scheme is 'keyword', it means that the subject is free-text (i.e. not a term from a controlled vocabulary).
+
+```json
+"value" : "pyrolysis-oil"
+```
diff --git a/docs/data-model/entities/project.md b/docs/data-model/entities/project.md
index 265255e..1678506 100644
--- a/docs/data-model/entities/project.md
+++ b/docs/data-model/entities/project.md
@@ -13,7 +13,7 @@ Of crucial interest to OpenAIRE is also the identification of the funders (e.g.
### id
_Type: String • Cardinality: ONE_
-Main entity identifier, created according to [OpenAIRE_entity_identifier_and_PID_mapping_policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy).
+Main entity identifier, created according to the [OpenAIRE entity identifier and PID mapping policy](entity-identifiers).
### code
_Type: String • Cardinality: ONE_
diff --git a/docs/data-model/entities/result.md b/docs/data-model/entities/result.md
index 92890c1..ff56aed 100644
--- a/docs/data-model/entities/result.md
+++ b/docs/data-model/entities/result.md
@@ -20,8 +20,11 @@ Moreover, there are the following sub-types of a `Result`, that inherit all its
### id
_Type: String • Cardinality: ONE_
-Main entity identifier, created according to
-[OpenAIRE entity identifier and PID mapping policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy).
+Main entity identifier, created according to the [OpenAIRE entity identifier and PID mapping policy](entity-identifiers).
+
+```json
+"id": "50|doi_dedup___::80f29c8c8ba18c46c88a285b7e739dc3"
+```
### type
_Type: String • Cardinality: ONE_
@@ -35,102 +38,293 @@ Type of the result. Possible types:
as declared in the terms from the [dnet:result_typologies vocabulary](https://api.openaire.eu/vocabularies/dnet:result_typologies).
+```json
+"type": "publication"
+```
+
### originalId
_Type: String • Cardinality: MANY_
Identifiers of the record at the original sources.
+```json
+"originalId": [
+ "oai:pubmedcentral.nih.gov:8024784",
+ "S0048733321000305",
+ "10.1016/j.respol.2021.104226",
+ "3136742816"
+]
+```
+
### maintitle
_Type: String • Cardinality: ONE_
A name or title by which a scientific result is known. May be the title of a publication, of a dataset or the name of a piece of software.
+```json
+"maintitle": "The fall of the innovation empire and its possible rise through open science"
+```
+
### subtitle
+
_Type: String • Cardinality: ONE_
Explanatory or alternative name by which a scientific result is known.
+```json
+"subtitle": "An analysis of cases from 1980 - 2020"
+```
+
### author
_Type: [Author](other#author) • Cardinality: MANY_
The main researchers involved in producing the data, or the authors of the publication.
+```json
+"author": [
+ {
+ "fullname": "E. Richard Gold",
+ "rank": 1,
+ "name": "Richard",
+ "surname": "Gold",
+ "pid": {
+ "id": {
+ "scheme": "orcid",
+ "value": "0000-0002-3789-9238"
+ },
+ "provenance" {
+ "provenance": "Harvested",
+ "trust": "0.9"
+ }
+ }
+ },
+ ...
+]
+```
### bestaccessright
_Type: [BestAccessRight](other#bestaccessright) • Cardinality: ONE_
The most open access right associated to the manifestations of this research results.
+```json
+"bestaccessright": {
+ "code": "c_abf2",
+ "label": "OPEN",
+ "scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
+}
+```
+
### contributor
_Type: String • Cardinality: MANY_
The institution or person responsible for collecting, managing, distributing, or otherwise contributing to the development of the resource.
+```json
+"contributor": [
+ "University of Zurich",
+ "Wright, Aidan G C",
+ "Hallquist, Michael",
+ ...
+]
+```
+
### country
_Type: [ResultCountry](other#resultcountry) • Cardinality: MANY_
Country associated with the result because it is the country of the organisation that manages the institutional repository or national aggregator or CRIS system from which this record was collected
Country of affiliations of authors can be found instead in the affiliation rel.
+```json
+"country": [
+ {
+ "code": "CH",
+ "label": "Switzerland",
+ "provenance": {
+ "provenance": "Inferred by OpenAIRE",
+ "trust": "0.85"
+ }
+ },
+ ...
+]
+```
+
### coverage
_Type: String • Cardinality: MANY_
-TODO
### dateofcollection
_Type: String • Cardinality: ONE_
When OpenAIRE collected the record the last time.
-TODO: we should indicate the used date format
+
+```json
+"dateofcollection": "2021-06-09T11:37:56.248Z"
+```
### description
_Type: String • Cardinality: MANY_
A brief description of the resource and the context in which the resource was created.
+```json
+"description": [
+ "Open science partnerships (OSPs) are one mechanism to reverse declining efficiency. OSPs are public-private partnerships that openly share publications, data and materials.",
+ "There is growing concern that the innovation system's ability to create wealth and attain social benefit is declining in effectiveness. This article explores the reasons for this decline and suggests a structure, the open science partnership, as one mechanism through which to slow down or reverse this decline.",
+ "The article examines the empirical literature of the last century to document the decline. This literature suggests that the cost of research and innovation is increasing exponentially, that researcher productivity is declining, and, third, that these two phenomena have led to an overall flat or declining level of innovation productivity.",
+ ...
+]
+```
+
### embargoenddate
_Type: String • Cardinality: ONE_
-Date when the embargo ends and this result turns Open Access. TODO: we should indicate the used date format
+Date when the embargo ends and this result turns Open Access.
+
+```json
+"embargoenddate": "2017-01-01"
+```
### instance
_Type: [Instance](other#instance) • Cardinality: MANY_
-Specific materialization or version of the result. For example, you can have one result with three instances: one is the pre-print, one is the post-print, one is the published version
+Specific materialization or version of the result. For example, you can have one result with three instances: one is the pre-print, one is the post-print, one is the published version.
+
+```json
+"instance": [
+ {
+ "accessright": {
+ "code": "c_abf2",
+ "label": "OPEN",
+ "openAccessRoute": "gold",
+ "scheme": "http://vocabularies.coar-repositories.org/documentation/access_rights/"
+ },
+ "alternateIdentifier": [
+ {
+ "scheme": "doi",
+ "value": "10.1016/j.respol.2021.104226"
+ },
+ ...
+ ],
+ "articleprocessingcharge": {
+ "amount": "4063.93",
+ "currency": "EUR"
+ },
+ "license": "http://creativecommons.org/licenses/by-nc/4.0",
+ "measures":[
+ {
+ "key": "influence",
+ "value": "6.45335454246e-09"
+ },
+ ...
+ ],
+ "pid": [
+ {
+ "scheme": "pmc",
+ "value": "PMC8024784"
+ },
+ ...
+ ],
+
+ "publicationdate": "2021-01-01",
+ "refereed": "UNKNOWN",
+ "type": "Article",
+ "url": [
+ "http://europepmc.org/articles/PMC8024784"
+ ]
+ },
+ ...
+]
+```
### language
_Type: [Language](other#language) • Cardinality: ONE_
-The `alpha-3/ISO 639-2` code of the language. Values controlled by the [dnet:languages vocabulary](https://api.openaire.eu/vocabularies/dnet:languages)
+The alpha-3/ISO 639-2 code of the language. Values controlled by the [dnet:languages vocabulary](https://api.openaire.eu/vocabularies/dnet:languages).
+```json
+"language": {
+ "code": "eng",
+ "label": "English"
+}
+```
### lastupdatetimestamp
_Type: Long • Cardinality: ONE_
Timestamp of last update of the record in OpenAIRE.
+```json
+"lastupdatetimestamp": 1652722279987
+```
+
### pid
_Type: [ResultPid](other#resultpid) • Cardinality: MANY_
-Persistent identifiers of the result. See also [OpenAIRE entity identifier and PID mapping policy](https://support.openaire.eu/projects/docs/wiki/OpenAIRE_entity_identifier_and_PID_mapping_policy) to learn more.
+Persistent identifiers of the result. See also the [OpenAIRE entity identifier and PID mapping policy](entity-identifiers) to learn more.
+
+```json
+"pid": [
+ {
+ "scheme":"pmc",
+ "value":"PMC8024784"
+ },
+ {
+ "scheme":"doi",
+ "value":"10.1016/j.respol.2021.104226"
+ },
+ ...
+]
+```
### publicationdate
_Type: String • Cardinality: ONE_
Main date of the research product: typically the publication or issued date. In case of a research result with different versions with different dates, the date of the result is selected as the most frequent well-formatted date. If not available, then the most recent and complete date among those that are well-formatted. For statistics, the year is extracted and the result is counted only among the result of that year. Example: Pre-print date: 2019-02-03, Article date provided by repository: 2020-02, Article date provided by Crossref: 2020, OpenAIRE will set as date 2019-02-03, because it’s the most recent among the complete and well-formed dates. If then the repository updates the metadata and set a complete date (e.g. 2020-02-12), then this will be the new date for the result because it becomes the most recent most complete date. However, if OpenAIRE then collects the pre-print from another repository with date 2019-02-03, then this will be the “winning date” because it becomes the most frequent well-formatted date.
+```json
+"publicationdate": "2021-03-18"
+```
+
### publisher
_Type: String • Cardinality: ONE_
The name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource.
+```json
+"publisher": "Elsevier, North-Holland Pub. Co"
+```
+
### source
_Type: String • Cardinality: MANY_
A related resource from which the described resource is derived. See definition of Dublin Core field [dc:source](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/elements11/source).
+```json
+"source": [
+ "Research Policy",
+ "Crossref",
+ ...
+]
+```
+
### subjects
_Type: [Subject](other#subject) • Cardinality: MANY_
Subject, keyword, classification code, or key phrase describing the resource.
+```json
+"subjecsts": [
+ {
+ "provenance": {
+ "provenance":"Harvested",
+ "trust":"0.9"
+ },
+ "subject": {
+ "scheme":"keyword",
+ "value":"Open science"
+ }
+ },
+ ...
+]
+```
---
## Sub-types
@@ -139,59 +333,127 @@ There are the following sub-types of `Result`. Each inherits all its fields and
### Publication
+Metadata records about research literature (includes types of publications listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/publication)).
+
#### container
_Type: [Container](other#container) • Cardinality: ONE_
Container has information about the conference or journal where the result has been presented or published.
+```json
+"container": {
+ "edition":"",
+ "iss":"5",
+ "issnLinking":"",
+ "issnOnline":"1873-7625",
+ "issnPrinted":"0048-7333",
+ "name":"Research Policy",
+ "sp":"12",
+ "ep":"22",
+ "vol":"50"
+}
+```
### Dataset
+Metadata records about research data (includes the subtypes listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/dataset)).
+
#### size
_Type: String • Cardinality: ONE_
-The size of the dataset.
+The declared size of the dataset.
+
+```json
+"size": "10129818"
+```
#### version
_Type: String • Cardinality: ONE_
The version of the dataset.
+```json
+"version": "v1.3"
+```
+
#### geolocation
_Type: [GeoLocation](other#geolocation) • Cardinality: MANY_
The list of geolocations associated with the dataset.
+```json
+"geolocation": [
+ {
+ "box": "18.569386 54.468973 18.066832 54.83707",
+ "place": "Tübingen, Baden-Württemberg, Southern Germany",
+ "point": "7.72486 50.1084"
+ },
+ ...
+]
+```
+
### Software
+Metadata records about research software (includes the subtypes listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/software)).
+
#### documentationUrl
_Type: String • Cardinality: MANY_
The URLs to the software documentation.
+```json
+"documentationUrl": [
+ "https://github.com/openaire/iis/blob/master/README.markdown",
+ ...
+]
+```
+
#### codeRepositoryUrl
_Type: String • Cardinality: ONE_
-The URL to the repository holding the source code,
+The URL to the repository with the source code.
+
+```json
+"codeRepositoryUrl": "https://github.com/openaire/iis"
+```
#### programmingLanguage
_Type: String • Cardinality: ONE_
The programming language.
+```json
+"programmingLanguage": "Java"
+```
+
### Other research product
+Metadata records about research products that cannot be classified as research literature, data or software (includes types of products listed [here](http://api.openaire.eu/vocabularies/dnet:result_typologies/other)).
+
#### contactperson
_Type: String • Cardinality: MANY_
-The contact person for this ORP.
+Information on the person responsible for providing further information regarding the resource.
+
+```json
+"contactperson": [
+ "Noémie Dominguez",
+ ...
+]
+```
#### contactgroup
_Type: String • Cardinality: MANY_
-The information for the contact group.
+Information on the group responsible for providing further information regarding the resource.
+
+```json
+"contactgroup": [
+ "Networked Multimedia Information Systems (NeMIS)",
+ ...
+]
+```
#### tool
_Type: String • Cardinality: MANY_
Information about tool useful for the interpretation and/or re-use of the research product.
-