Mapping between SKG Interoperability Framework and DDI 2.5¶
The SKG Interoperability Framework enables to exchange data about six core entities and their relationships These entities are: 1. Research Product – may be literature, data, software, or other 2. Agent – may represent a Person, an Organization, or a generic Agent linked to other entities 3. Grant – describes the funding of a project 4. Venue – models a publishing gateway 5. Topic – defines terms that can be used to describe a research product 6. Data Source – represents the storage location of a research product For more details, visit: https://skg-if.github.io/interoperability-framework/.
DDI 2.5 can be used to provide structured, descriptive documentation of a dataset’s content, meaning, provenance, and access. It includes metadata fields suitable for both quantitative and qualitative research data in the social, behavioral, economic, and health sciences. For more information, visit: https://ddialliance.org/ddi-codebook_v2.5 .
The mapping between SKG Interoperability Framework and DDI2.5 is intended for individuals who are familiar with DDI 2.5 but new to SKG-IF. To support this, it provides four columns related to SKG-IF: Property name (JSONPath), Type, Optional/recommended/mandatory and Description. For DDI 2.5, there is a single column: DDI 2.5 XPath (excluding Dublin Core fields). Additionally, the Notes column contains miscellaneous information about both SKG-IF and DDI 2.5.
Dataset as research product¶
Property JSONPath |
Type |
Optional/Recommended /Mandatory |
Description |
DDI 2.5 XPath (Dublin Core fields excluded) |
Notes |
|---|---|---|---|---|---|
$.local_identifier |
String |
mandatory |
An unique identifier in SKG, it is suggested to use URL as identifier |
The value of this field is implementation-dependent. |
|
$.identifiers[*] |
Array of Objects |
recommended |
The array of the objects representing external identifiers for the entity |
structure, no need to map |
|
$.identifiers[*].scheme |
String |
mandatory |
The scheme/name of the external identifier system |
Only in the case that this attribute is used for the name of the PID e.g. DOI |
|
$.identifiers[*].value |
String |
mandatory |
The external identifier |
/codeBook/stdyDscr/citation/titlStmt/IDNo |
Only in the case that this element is used for the PID e.g. 10.17026/dans-xpf-5u9e |
$.entity_type |
String |
mandatory |
Needed for parsing purposes; fixed to product. |
information can be generated because it is always “product” |
|
$.titles |
Object |
optional |
The titles of the entity |
structure, no need to map |
|
$.titles.ISO 639-1 language code |
name of the key |
? |
The name of the key, which must be ISO 639-1 language code and be the language of the content of the value |
/codeBook/stdyDscr/citation/titlStmt/titl/@xml:lang /codeBook/stdyDscr/citation/titlStmt/parTitl/@xml:lang |
If XML file is monolingual then /codeBook/@xml:lang is used |
$.titles.ISO 639-1 language code[*] |
Array of Strings |
? |
The list of the titles in the given (ISO 639-1) language, specified by the key name |
/codeBook/stdyDscr/citation/titlStmt/titl /codeBook/stdyDscr/citation/titlStmt/parTitl |
It also possible to map “titles” with the bibliographical citation if needed: /codeBook/stdyDscr/citation/rspStmt/biblCit |
$.abstracts |
Object |
optional |
The abstracts of the entity |
structure, no need to map |
|
$.abstracts.ISO 639-1 language code |
name of the key |
? |
The name of the key, which must be ISO 639-1 language code and be the language of the content of the value |
If XML file is monolingual then /codeBook/@xml:lang is used |
|
$.abstracts.ISO 639-1 language code[*] |
Array of Strings |
? |
The list of the abstracts in the given (ISO 639-1) language, specified by the key name |
/codeBook/stdyDscr/stdyInfo/abstract |
|
$.product_type |
String |
optional |
The type of the product , one of the values “research data”, “literature”, “research software”, “other” |
information can be generated because it is always “research data” |
|
$.topics[*] |
Array of Objects |
optional |
The array of the objects referring to entity Topic |
structure, no need to map |
|
$.topics[*].term |
String |
mandatory |
The reference, (local) identifier, of the topic relevant for this entity |
/codeBook/stdyDscr/stdyInfo/subject/keyword /codeBook/stdyDscr/stdyInfo/subject/topcClas |
Even if keyword and topcClas are the best mappings, it is possible to map any “vocabulary field” to this e.g. /codeBook/stdyDscr/sumDscr/anlyUnit /codeBook/stdyDscr/method/dataColl/timeMeth /codeBook/stdyDscr/method/dataColl/sampProc /codeBook/stdyDscr/method/dataColl/collMode /codeBook/stdyDscr/sumDscr/dataKind /codeBook/stdyDscr/method/dataColl/resInstru DDI-C does not support references to topics (or more generally to vocabulary terms). Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF the terms are documented using Topics entity and the related Topics entities are only referenced here using their identifier. |
$.topics[*].provenance |
Array of Objects |
recommended |
The provanance information tracking the software(s) used for adding topics and the trust in given relation . |
structure, no need to map |
|
$.topics[*].provenance.assoc iated_with |
String |
mandatory |
The reference, (local) identifier, of the Agent responsible for adding this term to this research product. |
not supported |
|
$.topics[*].provenance.trust |
Number (float) |
mandatory |
The trust given to the relation |
not supported |
|
$.contributions[*] |
Array of Objects |
optional |
The array of objects describing the contributors and their contribution |
structure, no need to map |
|
$.contributions[*].by |
String |
mandatory |
The reference (Identifier) of the agent contributing to the research product |
/codeBook/docDscr/citation/prodStmt/producer /codeBook/stdyDscr/citation/rspStmt/AuthEnty /codeBook/stdyDscr/citation/rspStmt/othId /codeBook/stdyDscr/citation/prodStmt/producer /codeBook/stdyDscr/method/dataColl/dataCollector /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant |
DDI-C does not support references. Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF the contributors are documented using Agent entity and the related Agent entities are only referenced here using their identifier. |
$.contributions[*].declared_ affiliations |
Array of Strings |
recommended |
The reference (identifier) of the agent which is affiliation of the contributor. |
/codeBook/docDscr/citation/prodStmt/producer/@affiliation /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/citation/prodStmt/producer/@affiliation /codeBook/stdyDscr/method/dataColl/dataCollector/@affiliation /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@affiliation |
DDI-C does not support references. Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF the contributor affiliations are documented using Agent entity and the related Agent entities are only referenced here using their identifier. |
$.contributions[*].rank |
Number (integer) |
recommended |
The rank of the agent (order of appearance e.g. in the list of authors) |
not supported |
|
$.contributions[*].role |
String |
recommended |
The role of the agent. The possible values are author, editor, publisher. |
information can be generated because it is always “author” |
|
$.contributions[*].contribut ion_types[*] |
Array of Strings |
recommended |
The contributions of the agent using CRediT taxonomy |
DDI-element mappings with CReciT taxonomy: /codeBook/docDscr/citation/prodStmt/producer: “Data curation” /codeBook/stdyDscr/citation/rspStmt/AuthEnty: “Conceptualization”, “Investigation”, “Methodology”, “Supervision” codeBook/stdyDscr/citation/rspStmt/othId: the mapping must be done case by case depending of the role in this work /codeBook/stdyDscr/citation/prodStmt/producer: “Project administration” /codeBook/stdyDscr/method/dataColl/dataCollector: “Investigation” codeBook/stdyDscr/studyDevelopment/developmentActivity/participant: mapping depends of the development activity type of the participant |
|
$.manifestations[*] |
Array of Objects |
optional |
Object representing different and multiple manifestations of the same research product |
structure, no need to map |
In the case of datasets, it is possible to only describe one manifestation for the most recent version or the document all different versions of the same datasets as manifestations. |
$.manifestations[*].type |
Object |
recommended |
The object representing the type of the manifestation. |
structure, no need to map |
|
$.manifestations[*].type.cla ss |
String |
recommended |
The URL of the class identifying the entity (e.g., in an ontology) describing that type. |
not applicable |
|
$.manifestations[*].type.lab els |
Object |
recommended |
The object used for documenting the labels |
not applicable |
|
$.manifestations[*].type.lab els.ISO 639-1 language code |
name of the key |
? |
The name of the key, which must be ISO 639-1 language code and be the language of the content of the value |
No need to fill in, if there is just one manifestation for a research product. If different versions of the dataset are described as manifestations, can be set to “Version” and use “en” as the name of the key. |
|
$.manifestations[*].type.lab els.ISO 639-1 language code[*] |
Array of Strings |
? |
The label describing the manifestation type. |
No need to fill in, if there is just one manifestation for a research product. If different versions of the dataset are described as manifestations, can be set to “Version”. |
|
$.manifestations[*].type.def ined_in |
String |
recommended |
The URL of the schema of the manifestation type, e.g., a link to the vocabulary of allowed product types. |
not applicable |
|
$.manifestations[*].dates |
Object |
recommended |
The object is a dictionary, the keys represent the type of date and the value is expressed as either a string or a list of string, where each string is compliant with the ISO 8601 datetime string. |
structure, no need to map |
Choose the dates suitable for your own use case. |
$.manifestations[*].dates.ac ceptance[*] |
String or Array of Strings |
? |
The date of acceptance |
not applicable |
|
$.manifestations[*].dates.ac cess[*] |
String or Array of Strings |
? |
The date on which a particular digital item has been accessed by somebody. |
not applicable |
|
$.manifestations[*].dates.co llected[*] |
String or Array of Strings |
? |
The date on which some item has been collected, for example the data gathered by means of questionnaires. |
||
$.manifestations[*].dates.co pyright[*] |
String or Array of Strings |
? |
The date on which an entity has been copyrighted. |
not applicable |
|
$.manifestations[*].dates.co rrection[*] |
String or Array of Strings |
? |
The date on which something, for example a document, is corrected. |
not applicable |
|
$.manifestations[*].dates.cr eation[*] |
String or Array of Strings |
? |
The date on which an entity has been created. |
||
$.manifestations[*].dates.de cision[*] |
String or Array of Strings |
? |
The date on which a particular endeavour, such as a grant application, has been or will be approved or rejected by somebody. |
not applicable |
|
$.manifestations[*].dates.de posit[*] |
String or Array of Strings |
? |
The date on which an entity has been deposited, for example in a library, repository, supplementary information archive, database or similar place of document or information storage. |
/codeBook/stdyDscr/othrStdyMat/relPubl/citation/distStmt/depDate/@date |
|
$.manifestations[*].dates.di stribution[*] |
String or Array of Strings |
? |
The date on which something is distributed, for example the date on which a preprint of a document is e-mailed to colleagues and other academics by the author(s), or the date on which a printed announcement of forthcoming theatre events is mailed to those those on the theatre’s mailing list. |
not applicable |
|
$.manifestations[*].dates.em bargo[*] |
String or Array of Strings |
? |
The date before which an entity should not be published, or before which a press release should not be reported on. For open-access journal articles, the embargo date is the date before which availability of the open-access version of the article is restricted by the publisher, following subscription-access availability of the published work. |
not supported |
|
$.manifestations[*].dates.mo dified[*] |
String or Array of Strings |
? |
The date on which an entity has been modified. |
||
$.manifestations[*].dates.pu blication[*] |
String or Array of Strings |
? |
The date of formal issuance of a resource (e.g. a publication or a patent). |
||
$.manifestations[*].dates.re ceived[*] |
String or Array of Strings |
? |
The date on which some item is received, for example a document being received by a publisher. |
not applicable |
|
$.manifestations[*].dates.re quest[*] |
String or Array of Strings |
? |
The date on which an agent is requested to do something, for example a reviewer is requested to write a review of a paper submitted to a journal for publication, or an author is requested to supply a revised version of the paper in response to the reviews received. |
not applicable |
|
$.manifestations[*].dates.re traction[*] |
String or Array of Strings |
? |
The date on which something, for example a claim or a journal article, is retracted. |
not applicable |
|
$.manifestations[*].dates.va lidity[*] |
String or Array of Strings |
? |
Date of validity of a resource. |
not applicable |
|
$.manifestations[*].identifi ers[*] |
Array of Objects |
recommended |
External identifiers of the manifestationt |
structure, no need to map |
This is not mandatory information. In the case of documenting just the most recent version of the dataset, this information already is documented in $.identifiers[*]. |
$.manifestations[*].identifi ers[*].scheme |
String |
mandatory |
The scheme for the external identifier. |
Only in the case that this attribute is used for the name of the PID e.g. DOI. |
|
$.manifestations[*].identifi ers[*].value |
String |
mandatory |
The external identifier. |
/codeBook/stdyDscr/citation/titlStmt/IDNo |
Only in the case that this element is used for the PID e.g. 10.17026/dans-xpf-5u9e |
$.manifestations[*].peer_rev iew |
Object |
recommended |
Whether the manifestation has undergone a peer review. |
structure, no need to map |
|
$.manifestations[*].peer_rev iew.status |
String |
mandatory |
The status (reviewed or not yet) of the peer- review. |
not applicable |
|
$.manifestations[*].peer_rev iew.description |
String |
recommended |
The type of peer review. Allowed values: single- blind peer review, double-blind peer review, open peer review. |
not applicable |
|
$.manifestations[*].access_r ights |
Object |
recommended |
The access rights of this manifestation |
structure, no need to map |
|
$.manifestations[*].access_r ights.status |
String |
mandatory |
Describes if the manifestation is open access (open), closed access (closed), under embargo (embargoed), restricted access (restricted), or unavailable for some reason (unavailable). |
/codeBook/stdyDscr/dataAccs/useStmt/conditions |
There is no perfect field for this in DDI2.5. All the “access information” fields are more like a free text fields. |
$.manifestations[*].access_r ights.description |
String |
recommended |
Describe and qualify the specific status selected. |
/codeBook/stdyDscr/dataAccs/useStmt/restrctn |
|
$.manifestations[*].licence |
String |
recommended |
The URL of the licence specific to the manifestation. |
not supported |
|
$.manifestations[*].version |
String |
recommended |
The version for a software or research data product. |
/codeBook/docDscr/citation/verStmt/version |
|
$.manifestations[*].biblio |
Object |
optional |
An object containing bibliographic information about a manifestation. |
structure, no need to map |
|
$.manifestations[*].biblio.i ssue |
String |
optional |
Issue number |
not applicable |
|
$.manifestations[*].biblio.p ages |
Object |
optional |
The pages (e.g. of the book or journal) where the manifestation in defined |
not applicable |
|
$.manifestations[*].biblio.p ages.first |
String |
mandatory |
The starting page |
not applicable |
|
$.manifestations[*].biblio.p ages.last |
String |
mandatory |
The ending page |
not applicable |
|
$.manifestations[*].biblio.v olume |
String |
optional |
Volume number (for journals, books, conferences) |
not applicable |
|
$.manifestations[*].biblio.e dition |
String |
optional |
The edition (for journals and books) |
not applicable |
|
$.manifestations[*].biblio.n umber |
String |
optional |
A number of the manifestation within Venue (e.g. chapter number) |
not applicable |
|
$.manifestations[*].biblio.i n |
String |
optional |
A Venue identifier for the manifestation. |
/codeBook/stdyDscr/citation/distStmt/distrbtr The mapping of the field is dependent on the implementation. If metadata is harvested and published by a second party, then there is no mapping. |
DDI-C does not support references. Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF the venue/publishing gateway is documented using Venue entity and the related Venue entities are only referenced here using their identifier. |
$.manifestations[*].biblio.h osting_data_source |
String |
optional |
A Data source identifier for the manifestation. |
DDI-C does not support references. Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF the venue/publishing gateway is documented using Venue entity and the related Venue entities are only referenced here using their identifier. |
|
$.relevant_organisations[*] |
Array of Strings |
optional |
Relevant Organisation identifiers associated with a Research product, in case the individual affiliations of an Agent are not available. |
not applicable |
|
$.funding[*] |
Array of Strings |
optional |
Relevant Grant identifiers associated with a Research product. |
/codeBook/stdyDscr/citation/prodStmt/grantNo |
DDI-C does not support references. Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF the grant is documented using Grant entity and the related Grant entities are only referenced here using their identifier. |
$.related_products |
Object |
optional |
Related Research products, where the semantics of such relationships is specified as a key. |
structure, no need to map |
|
$.related_products.cites[*] |
Array of Strings |
optional |
Research products identifiers that are cited by a given Research product. |
In SKG publication e.g. article using a dataset tells which datasets it cites. In DDI2.5 it is other way around, the dataset has the information which publications are related to (using) the dataset. Therefore mapping for this field is done with element “pointing” from dataset to the publication which cites the dataset. /codeBook/stdyDscr/othrStdyMat/relPubl |
|
$.related_products.is_supple mented_by[*] |
Array of Strings |
optional |
Research products identifiers that are supplement of a given Research product. |
/codeBook/otherMat |
DDI-C does not support references. Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF is_supplemented_by is documented using Research Product entity and the related Research Product entities are only referenced here using their identifier. |
$.related_products.is_docume nted_by[*] |
Array of Strings |
optional |
Research products identifiers that documents a given Research product. |
/codeBook/stdyDscr/othrStdyMat/relMat |
DDI-C does not support references. Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF is_documented_by is documented using Research Product entity and the related Research Product entities are only referenced here using their identifier. |
$.related_products.is_new_ve rsion_of[*] |
Array of Strings |
optional |
Research products identifiers that are prior versions of a given Research product. |
not applicable |
|
$.related_products.is_part_o f[*] |
Array of Strings |
optional |
Research products identifiers that contain the current Research product. |
/codeBook/stdyDscr/citation/serStmt |
DDI-C does not support references. Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF is_part_of is documented using Research Product entity and the related Research Product entities are only referenced here using their identifier. |
Person¶
Property JSONPath |
Type |
Optional/Recommended /Mandatory |
Description |
DDI 2.5 (Dublin Core fields excluded) |
Notes |
|---|---|---|---|---|---|
$.local_identifier |
String |
mandatory |
An unique identifier in SKG, it is suggested to use URL as identifier |
The value of this field is implementation-dependent. |
|
$.identifiers[*] |
Array of Objects |
recommended |
The array of the objects representing external identifiers for the entity |
structure, no need to map |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.identifiers[*].scheme |
String |
mandatory |
The scheme/name of the external identifier system |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink/@title Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink/@title Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink/@title Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@title /codeBook/otherMat/citation/citation/rspStmt/othId/@title /codeBook/otherMat/citation/citation/prodStmt/producer/@title |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.identifiers[*].value |
String |
mandatory |
The external identifier |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty /codeBook/otherMat/citation/citation/rspStmt/othId /codeBook/otherMat/citation/citation/prodStmt/producer |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.entity_type |
String |
mandatory |
Field stating the kind of entity, can be agent (generic), person or organisation |
information can be generated because it is always “person” |
DDI2.5 do not have field stating if an agent is a person or an organization. It is possible to separate person and organisation only if considered that AuthEnty (or other contributor field) is a person when it has affiliation attribute attached. |
$.name |
String |
optional |
The string containing whatever concatenation of an Agent name(s). |
Dataset: /codeBook/docDscr/citation/prodStmt/producer /codeBook/stdyDscr/citation/rspStmt/AuthEnty /codeBook/stdyDscr/citation/rspStmt/othId /codeBook/stdyDscr/citation/prodStmt/producer /codeBook/stdyDscr/method/dataColl/dataCollector /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty /codeBook/otherMat/citation/citation/rspStmt/othId /codeBook/otherMat/citation/citation/prodStmt/producer |
|
$.given_name |
String |
optional |
The given name of a Person. |
not supported |
|
$.family_name |
String |
optional |
The family name of a Person. |
not supported |
|
$.affiliations[*] |
Array of Objects |
optional |
All the affiliations of a Person |
structure, no need to map |
|
$.affiliations[*].affiliatio n |
String |
mandatory |
The identifier of an Organisation a Person is affiliated with. |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/@affiliation /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/citation/prodStmt/producer/@affiliation /codeBook/stdyDscr/method/dataColl/dataCollector/@affiliation /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@affiliation Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@affiliation Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@affiliation Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@affiliation /codeBook/otherMat/citation/citation/rspStmt/othId/@affiliation /codeBook/otherMat/citation/citation/prodStmt/producer/@affiliation |
DDI-C does not support references. Therefore there is no direct mapping for this field. This mapping is based on the suitable information content. Note that in SKG-IF the contributor affiliations are documented using Agent entity and the related Agent entities are only referenced here using their identifier. |
$.affiliations[*].role |
String |
recommended |
The role that a Person had in the context of an Organisation. Needed for parsing purposes; fixed to affiliate. |
information can be generated because it is always “affiliate” |
|
$.affiliations[*].role.perio d |
Object |
recommended |
The time period where the Person was affiliated with an Organisation. |
not applicable |
|
$.affiliations[*].role.perio d.start |
String |
recommended |
The start datetime of the affiliation with an Organisation. The string should be compliant with the ISO 8601 datetime string. |
not applicable |
|
$.affiliations[*].role.perio d.end |
String |
recommended |
The end datetime (if any) of the affiliation with an Organisation. The string should be compliant with the ISO 8601 datetime string. |
not applicable |
Affiliation of a person as Organisation¶
Property JSONPath |
Type |
Optional/Recommended /Mandatory |
Description |
DDI 2.5 XPath (Dublin Core fields excluded) |
Notes |
|---|---|---|---|---|---|
$.local_identifier |
String |
mandatory |
An unique identifier in SKG, it is suggested to use URL as identifier |
The value of this field is implementation-dependent. |
|
$.identifiers[*] |
Array of Objects |
recommended |
The array of the objects representing external identifiers for the entity |
structure, no need to map |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.identifiers[*].scheme |
String |
mandatory |
The scheme/name of the external identifier system |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink/@title Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink/@title Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink/@title Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@title /codeBook/otherMat/citation/citation/rspStmt/othId/@title /codeBook/otherMat/citation/citation/prodStmt/producer/@title |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.identifiers[*].value |
String |
mandatory |
The external identifier |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty /codeBook/otherMat/citation/citation/rspStmt/othId /codeBook/otherMat/citation/citation/prodStmt/producer |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.entity_type |
String |
mandatory |
Field stating the kind of entity, can be agent (generic), person or organisation |
information can be generated because it is always “person” |
DDI2.5 do not have field stating if an agent is a person or an organization. It is possible to separate person and organisation only if considered that AuthEnty (or other contributor field) is a person when it has affiliation attribute attached. |
$.name |
String |
optional |
The string containing whatever concatenation of an Agent name(s). |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/@affiliation /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/citation/prodStmt/producer/@affiliation /codeBook/stdyDscr/method/dataColl/dataCollector/@affiliation /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@affiliation Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@affiliation Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@affiliation Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@affiliation /codeBook/otherMat/citation/citation/rspStmt/othId/@affiliation /codeBook/otherMat/citation/citation/prodStmt/producer/@affiliation |
|
$.short_name |
String |
optional |
The short name/acronym for an Organisation. |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/@abbr /codeBook/stdyDscr/citation/prodStmt/producer/@abbr /codeBook/stdyDscr/method/dataColl/dataCollector/@abbr /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@abbr Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@abbr Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@abbr Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/prodStmt/producer/@abbr |
These fields do not support abbreviation Dataset: /codeBook/stdyDscr/citation/rspStmt/AuthEnty /codeBook/stdyDscr/citation/rspStmt/othId Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/Auth Enty /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othI d Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthE nty /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty /codeBook/otherMat/citation/citation/rspStmt/othId |
$.other_names[*] |
Array of Strings |
optional |
Other names, perhaps in different languages, identifying an Organisation. |
DDI2.5 includes possibility for multilingual metadata by using xml:lang attribute for all of these fields: Dataset: /codeBook/docDscr/citation/prodStmt/producer/@affiliation /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/citation/prodStmt/producer/@affiliation /codeBook/stdyDscr/method/dataColl/dataCollector/@affiliation /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@affiliation Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@affiliation Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/@affiliation /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/@affiliation /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@affiliation Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@affiliation /codeBook/otherMat/citation/citation/rspStmt/othId/@affiliation /codeBook/otherMat/citation/citation/prodStmt/producer/@affiliation |
|
$.website |
String |
optional |
The website URL for an Organisation. |
not supported |
|
$.country |
String |
optional |
The country code of an Organisation |
not applicable |
|
$.type |
String |
optional |
The types of an Organisation. |
not applicable |
Organisation¶
Property JSONPath |
Type |
Optional/Recommended /Mandatory |
Description |
DDI 2.5 XPath (Dublin Core fields excluded) |
Notes |
|---|---|---|---|---|---|
$.local_identifier |
String |
mandatory |
An unique identifier in SKG, it is suggested to use URL as identifier |
The value of this field is implementation-dependent. |
|
$.identifiers[*] |
Array of Objects |
recommended |
The array of the objects representing external identifiers for the entity |
structure, no need to map |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.identifiers[*].scheme |
String |
mandatory |
The scheme/name of the external identifier system |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink/@title /codeBook/stdyDscr/citation/prodStmt/fundAg/ExtLink/@title /codeBook/stdyDscr/citation/prodStmt/grantNo/ExtLink/@title Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/grantNo/ExtLink/@title Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/grantNo/ExtLink/@title Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/rspStmt/AuthEnty/@title /codeBook/otherMat/citation/rspStmt/othId/@title /codeBook/otherMat/citation/prodStmt/producer/@title /codeBook/otherMat/citation/prodStmt/fundAg/ExtLink/@title /codeBook/otherMat/citation/prodStmt/grantNo/ExtLink/@title |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.identifiers[*].value |
String |
mandatory |
The external identifier |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink /codeBook/stdyDscr/citation/prodStmt/fundAg/ExtLink /codeBook/stdyDscr/citation/prodStmt/grantNo/ExtLink Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/grantNo/ExtLink Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg/ExtLink /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/grantNo/ExtLink Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/rspStmt/AuthEnty /codeBook/otherMat/citation/rspStmt/othId /codeBook/otherMat/citation/prodStmt/producer /codeBook/otherMat/citation/prodStmt/fundAg/ExtLink /codeBook/otherMat/citation/prodStmt/grantNo/ExtLink |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.entity_type |
String |
mandatory |
Field stating the kind of entity, can be agent (generic), person or organisation |
information can be generated because it is always “organisation” |
DDI2.5 do not have field stating if an agent is a person or an organization. It is possible to separate person and organisation only if considered that AuthEnty (or other contributor field) is a person when it has affiliation attribute attached. |
$.name |
String |
optional |
The string containing whatever concatenation of an Agent name(s). |
Dataset: /codeBook/docDscr/citation/prodStmt/producer /codeBook/stdyDscr/citation/rspStmt/AuthEnty /codeBook/stdyDscr/citation/rspStmt/othId /codeBook/stdyDscr/citation/prodStmt/producer /codeBook/stdyDscr/method/dataColl/dataCollector /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant /codeBook/stdyDscr/citation/prodStmt/fundAg /codeBook/stdyDscr/citation/prodStmt/grantNo/@agency Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/AuthEnty /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/othId /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/producer /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/grantNo/@agency Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/AuthEnty /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/othId /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/producer /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/grantNo/@agency Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/rspStmt/AuthEnty /codeBook/otherMat/citation/rspStmt/othId /codeBook/otherMat/citation/prodStmt/producer /codeBook/otherMat/citation/prodStmt/fundAg /codeBook/otherMat/citation/prodStmt/grantNo/@agency |
|
$.short_name |
String |
optional |
The short name/acronym for an Organisation. |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/@abbr /codeBook/stdyDscr/citation/prodStmt/producer/@abbr /codeBook/stdyDscr/method/dataColl/dataCollector/@abbr /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@abbr /codeBook/stdyDscr/citation/prodStmt/fundAg/@abbr Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@abbr /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg/@abbr Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@abbr /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg/@abbr Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/prodStmt/producer/@abbr /codeBook/otherMat/citation/prodStmt/fundAg/@abbr |
|
$.other_names[*] |
Array of Strings |
optional |
Other names, perhaps in different languages, identifying an Organisation. |
DDI2.5 includes possibility for multilingual metadata by using xml:lang attribute for all of these fields: Dataset: /codeBook/docDscr/citation/prodStmt/producer /codeBook/stdyDscr/citation/rspStmt/AuthEnty /codeBook/stdyDscr/citation/rspStmt/othId /codeBook/stdyDscr/citation/prodStmt/producer /codeBook/stdyDscr/method/dataColl/dataCollector /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant /codeBook/stdyDscr/citation/prodStmt/fundAg /codeBook/stdyDscr/citation/prodStmt/grantNo/@agency Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/AuthEnty /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/othId /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/producer /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/grantNo/@agency Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/AuthEnty /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/othId /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/producer /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/grantNo/@agency Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/rspStmt/AuthEnty /codeBook/otherMat/citation/rspStmt/othId /codeBook/otherMat/citation/prodStmt/producer /codeBook/otherMat/citation/prodStmt/fundAg /codeBook/otherMat/citation/prodStmt/grantNo/@agency |
|
$.website |
String |
optional |
The website URL for an Organisation. |
not supported |
|
$.country |
String |
optional |
The country code of an Organisation |
not applicable |
|
$.type |
String |
optional |
The types of an Organisation. |
not applicable |
Agent (not known if it is Person or Organization)¶
Property JSONPath |
Type |
Optional/Recommended /Mandatory |
Description |
DDI 2.5 XPath (Dublin Core fields excluded) |
Notes |
|---|---|---|---|---|---|
$.local_identifier |
String |
mandatory |
An unique identifier in SKG, it is suggested to use URL as identifier |
The value of this field is implementation-dependent. |
|
$.identifiers[*] |
Array of Objects |
recommended |
The array of the objects representing external identifiers for the entity |
structure, no need to map |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.identifiers[*].scheme |
String |
mandatory |
The scheme/name of the external identifier system |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink/@title /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink/@title Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink/@title Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink/@title /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink/@title Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@title /codeBook/otherMat/citation/citation/rspStmt/othId/@title /codeBook/otherMat/citation/citation/prodStmt/producer/@title |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.identifiers[*].value |
String |
mandatory |
The external identifier |
Dataset: /codeBook/docDscr/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty /codeBook/otherMat/citation/citation/rspStmt/othId /codeBook/otherMat/citation/citation/prodStmt/producer |
Using ExtLink element is a workaround, there is not actually a field for Persistent Identifiers for any Agent, Person or Organization in DDI2.5. /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant does not include ExtLink |
$.entity_type |
String |
mandatory |
Field stating the kind of entity, can be agent (generic), person or organisation |
information can be generated because it is always “agent” |
|
$.name |
String |
optional |
The string containing whatever concatenation of an Agent name(s). |
Dataset: /codeBook/docDscr/citation/prodStmt/producer /codeBook/stdyDscr/citation/rspStmt/AuthEnty /codeBook/stdyDscr/citation/rspStmt/othId /codeBook/stdyDscr/citation/prodStmt/producer /codeBook/stdyDscr/method/dataColl/dataCollector /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant Publication citing (cites) the dataset (related publication): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer Material documenting (is_documented_by) the dataset (related material): /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer Material supplementing (is_supplemented_by) the dataset (other material): /codeBook/otherMat/citation/citation/rspStmt/AuthEnty /codeBook/otherMat/citation/citation/rspStmt/othId /codeBook/otherMat/citation/citation/prodStmt/producer |
Grant¶
Property JSONPath |
Type |
Optional/Recommended /Mandatory |
Description |
DDI 2.5 XPath (Dublin Core fields excluded) |
Notes |
|---|---|---|---|---|---|
$.local_identifier |
String |
mandatory |
An unique identifier in SKG, it is suggested to use URL as identifier |
The value of this field is implementation-dependent. |
|
$.grant_number |
String |
recommended |
Unique code identifying the Grant at the funder. |
/codeBook/stdyDscr/citation/prodStmt/grantNo |
|
$.identifiers[*] |
Array of Objects |
recommended |
The array of the objects representing external identifiers for the entity |
structure, no need to map |
|
$.identifiers[*].scheme |
String |
mandatory |
The scheme/name of the external identifier system |
not supported |
|
$.identifiers[*].value |
String |
mandatory |
The external identifier |
not supported |
|
$.entity_type |
String |
mandatory |
Needed for parsing purposes; fixed to grant. |
information can be generated because it is always “grant” |
|
$.titles |
Object |
optional |
The titles of the entity |
not applicable |
|
$.titles.ISO 639-1 language code |
name of the key |
? |
The name of the key, which must be ISO 639-1 language code and be the language of the content of the value |
not applicable |
|
$.titles.ISO 639-1 language code[*] |
Array of Strings |
? |
The list of the titles in the given (ISO 639-1) language, specified by the key name |
not applicable |
|
$.abstracts |
Object |
optional |
The abstracts of the entity |
not applicable |
|
$.abstracts.ISO 639-1 language code |
name of the key |
? |
The name of the key, which must be ISO 639-1 language code and be the language of the content of the value |
not applicable |
|
$.abstracts.ISO 639-1 language code[*] |
Array of Strings |
? |
The list of the abstracts in the given (ISO 639-1) language, specified by the key name |
not applicable |
|
$.acronym |
String |
optional |
The acronym of the grant |
not applicable |
|
$.funding_agency |
String |
optional |
The reference (identifier) of an agent (Organisation) funding the Grant. |
||
$.funding_stream |
String |
optional |
The funding stream of the Grant e.g. Horizon Europe |
not applicable |
|
$.currency |
String |
optional |
Currency of the funded amount. Mandatory if funded_amount is provided) |
not applicable |
|
$.funded_amount |
Numeric |
optional |
Amount funded |
not applicable |
|
$.keywords[*] |
Array of Strings |
optional |
Keywords |
not applicable |
|
$.duration |
Object |
optional |
Duration of the Grant |
not applicable |
|
$.duration.start |
String |
mandatory |
Start date |
not applicable |
|
$.duration.end |
String |
optional |
End date |
not applicable |
|
$.website |
String |
optional |
The URL of the funded project website. |
not applicable |
|
$.beneficiaries[*] |
Array of Strings |
optional |
The references (identifiers) of the Organization Agents funded by the Grant |
not applicable |
|
$.contributions[*] |
Array of Objects |
optional |
The array of objects describing the contributors and their contribution |
structure, no need to map |
|
$.contributions[*].by |
String |
mandatory |
The reference (Identifier) of the agent contributing to the grant |
not applicable |
|
$.contributions[*].declared_ affiliations[*] |
Array of Strings |
recommended |
The reference (identifier) of the agent which is affiliation of the contributor. |
not applicable |
|
$.contributions[*].role[*] |
Array of Strings |
recommended |
The role of the agent. SCoro project roles: co-applicant, lead applican, project leader, project manager, project member, workpackage leader |
not applicable |
Venue¶
Property JSONPath |
Type |
Optional/Recommended /Mandatory |
Description |
DDI 2.5 XPath (Dublin Core fields excluded) |
Notes |
|---|---|---|---|---|---|
$.local_identifier |
String |
mandatory |
An unique identifier in SKG, it is suggested to use URL as identifier |
The value of this field is implementation-dependent. |
|
$.identifiers[*] |
Array of Objects |
recommended |
The array of the objects representing external identifiers for the entity |
structure, no need to map |
|
$.identifiers[*].scheme |
String |
mandatory |
The scheme/name of the external identifier system |
If the contents of the URI attribute are used as the identifier then this should be set to “url” |
|
$.identifiers[*].value |
String |
mandatory |
The external identifier |
||
$.entity_type |
String |
mandatory |
Needed for parsing purposes; fixed to venue |
information can be generated because it is always “venue” |
|
$.name |
String |
optional |
The name of a Venue. |
/codeBook/stdyDscr/citation/distStmt/distrbtr |
|
$.acronym |
String |
optional |
Acronym used by a Venue. |
||
$.type |
String |
optional |
The type of a Venue. Allowed values: journal, conference, book, repository, other, unknown |
Most of the times this value would be set to “repository” |
|
$.series |
String |
optional |
The name of the conference or book series. |
not applicable |
The desciption of the field says that it is meant for the venues of type “conference” or “book” |
$.access_rights |
Object |
recommended |
The access right for the specific journal. |
not applicable |
The desciption of the field says that it is meant for the venues of type “journal” |
$.access_rights.status |
String |
mandatory |
The description if the journal is open access (open), closed access (closed), or hybrid |
not applicable |
The desciption of the field says that it is meant for the venues of type “journal” |
$.access_rights.description |
String |
recommended |
Describe and qualify the specific status selected. |
not applicable |
The desciption of the field says that it is meant for the venues of type “journal” |
$.creation_date |
String |
optional |
The date of creation of a Venue. |
not applicable |
|
$.contributions[*] |
Array of Objects |
optional |
The array of objects describing the contributors and their contribution |
not applicable |
|
$.contributions[*].by |
String |
mandatory |
The reference (Identifier) of the agent contributing to the research Venue. |
not applicable |
|
$.contributions[*].role |
String |
recommended |
The role of the agent. The possible values are editor, publisher. |
not applicable |
Topic when collected from DDI2.5 files¶
Property JSONPath |
Type |
Optional/Recommended /Mandatory |
Description |
DDI 2.5 XPath (Dublin Core fields excluded) |
Notes |
|---|---|---|---|---|---|
$.local_identifier |
String |
mandatory |
An unique identifier in SKG, it is suggested to use URL as identifier |
The value of this field is implementation-dependent. |
When topic information is collected from DDI2.5, it is quite likely that “on-the-fly” local identifiers will be used. |
$.identifiers[*] |
Array of Objects |
recommended |
The array of the objects representing external identifiers for the entity |
structure, no need to map |
|
$.identifiers[*].scheme |
String |
mandatory |
The scheme/name of the external identifier system |
/codeBook/stdyDscr/stdyInfo/subject/keyword/ExtLink/@title /codeBook/stdyDscr/stdyInfo/subject/topcClas/ExtLink/@title |
Using ExtLink element is a workaround, there is not actually a field for (Persistent) Identifiers Even if keyword and topcClas are the best mappings, it is possible to map any “vocabulary field” to this e.g. /codeBook/stdyDscr/sumDscr/anlyUnit/ExtLink/@title /codeBook/stdyDscr/method/dataColl/timeMeth/ExtLink/@title /codeBook/stdyDscr/method/dataColl/sampProc/ExtLink/@title /codeBook/stdyDscr/method/dataColl/collMode/ExtLink/@title /codeBook/stdyDscr/sumDscr/dataKind/ExtLink/@title /codeBook/stdyDscr/method/dataColl/resInstru/ExtLink/@title |
$.identifiers[*].value |
String |
mandatory |
The external identifier |
/codeBook/stdyDscr/stdyInfo/subject/keyword/ExtLink /codeBook/stdyDscr/stdyInfo/subject/topcClas/ExtLink |
Even if keyword and topcClas are the best mappings, it is possible to map any “vocabulary field” to this e.g. /codeBook/stdyDscr/sumDscr/anlyUnit/ExtLink /codeBook/stdyDscr/method/dataColl/timeMeth/ExtLink /codeBook/stdyDscr/method/dataColl/sampProc/ExtLink /codeBook/stdyDscr/method/dataColl/collMode/ExtLink /codeBook/stdyDscr/sumDscr/dataKind/ExtLink /codeBook/stdyDscr/method/dataColl/resInstru/ExtLink |
$.entity_type |
String |
mandatory |
Needed for parsing purposes; fixed to topic. |
information can be generated because it is always “topic” |
|
$.labels |
Object |
optional |
Labels (terms) |
structure, no need to map |
|
$.labels.ISO 639-1 language code |
name of the key |
? |
The name of the key, which must be ISO 639-1 language code and be the language of the content of the value |
/codeBook/stdyDscr/stdyInfo/subject/keyword/@xml:lang /codeBook/stdyDscr/stdyInfo/subject/topcClas/@xml:lang |
Even if keyword and topcClas are the best mappings, it is possible to map any “vocabulary field” to this e.g. /codeBook/stdyDscr/sumDscr/anlyUnit/@xml:lang /codeBook/stdyDscr/method/dataColl/timeMeth/@xml:lang /codeBook/stdyDscr/method/dataColl/sampProc/@xml:lang /codeBook/stdyDscr/method/dataColl/collMode/@xml:lang /codeBook/stdyDscr/sumDscr/dataKind/@xml:lang /codeBook/stdyDscr/method/dataColl/resInstru/@xml:lang |
$.labels.ISO 639-1 language code[*] |
Array of Strings |
? |
Label describing a Topic in the given (ISO 639-1) language, specified by the key name |
/codeBook/stdyDscr/stdyInfo/subject/keyword /codeBook/stdyDscr/stdyInfo/subject/topcClas |
Even if keyword and topcClas are the best mappings, it is possible to map any “vocabulary field” to this e.g. /codeBook/stdyDscr/sumDscr/anlyUnit /codeBook/stdyDscr/method/dataColl/timeMeth /codeBook/stdyDscr/method/dataColl/sampProc /codeBook/stdyDscr/method/dataColl/collMode /codeBook/stdyDscr/sumDscr/dataKind /codeBook/stdyDscr/method/dataColl/resInstru |
Data source¶
Property JSONPath |
Type |
Optional/Recommended /Mandatory |
Description |
DDI 2.5 XPath (Dublin Core fields excluded) |
Notes |
|---|---|---|---|---|---|
$.local_identifier |
String |
mandatory |
An unique identifier in SKG, it is suggested to use URL as identifier |
The value of this field is implementation-dependent. |
|
$.identifiers[*] |
Array of Objects |
recommended |
The array of the objects representing external identifiers for the entity |
structure, no need to map |
|
$.identifiers[*].scheme |
String |
mandatory |
The scheme/name of the external identifier system |
Using ExtLink element is a workaround, there is not actually a field for identifier/URL pointing to the organization (data source) |
|
$.identifiers[*].value |
String |
mandatory |
The external identifier |
||
$.entity_type |
String |
mandatory |
Needed for parsing purposes; fixed to datasource |
information can be generated because it is always “datasource” |
|
$.name |
String |
optional |
The name of a Data source. |
||
$.persistent_identity_system s[*] |
Array of Objects |
optional |
The persistent identifier systems that are used by a Data source to identify the ProductType it supports. |
not applicable |
|
$.persistent_identity_system s[*].for |
? |
mandatory |
The Product type to which the persistent identifier is referring to. Allowed values: literature, research data, software, metadata, any |
not applicable |
|
$.persistent_identity_system s[*].pid_schemes[*] |
Array of Strings |
mandatory |
Persistent identifier schemes used to refer to ProductTypes. |
not applicable |
|
$.audience[*] |
Array of Objects |
optional |
The property defines the target audiences of the users of a Data source. |
not applicable |
|
$.audience[*].audience_type |
String |
mandatory |
The type of the audience based on the vocabulary “Jurisdiction”. Allowed values “Global”, “National”, “Regional”, “Institution”, “Research infrastructure”, “e-infrastructure” |
not applicable |
|
$.data_source_classification |
String |
optional |
The specific type of a Data source, based on the vocabulary Data source Classification. It can be chosen among the following values: repository, aggregator, scientific database, journal archive, publisher archive, cris system |
not applicable |
|
$.research_product_type[*] |
Array of Strings |
optional |
The types of entities managed by a Data source. Each item in the list should be compliant with the following terms: metadata, research data, literature, software, any |
not applicable |
|
$.disciplines[*] |
Array of Strings |
optional |
The disciplines for which a Data source is dedicated - specified using the Library of Congress Classification codes, available at https://id.loc.gov/authorities/classification (e.g. PA3000-PA3049 for classical literature). In case a Data source is discipline agnostic, the string all should be specified. |
not applicable |
|
$.policies[*] |
Array of Objects |
optional |
The policies followed by a Data source. |
not applicable |
|
$.policies.about |
String |
mandatory |
The type of policy to consider. |
not applicable |
|
$.policies.target[*] |
Array of Strings |
recommended |
The types of resources to which the policy applies to, allowed values: : metadata, research data, literature, software, any |
not applicable |
|
$.policies.documented_at |
String |
recommended |
The URL of the document that describes the policy. |
not applicable |
|
$.policies.description |
String |
recommended |
Describe the type of policy, if necessary. |
not applicable |