Resource Model Data Dictionary
Summary
| Resource Model Entity |
Description |
Agreement | Represents terms or conditions that govern the submission of the Article. Encapsulates any and all form of agreement or contract related to the Submission, Article, or Data Files. |
Article | The intellectual content being published, typically a copy of an article that has been accepted for publication, post peer-review. Represents the Author Accepted Manuscript or Published Article. The primary intellectual output captured by a Submission. |
Award | Represents funding that enabled or contributed to the research documented or performed in the article. The award or awards that funded the research represented in the Article or data files. |
Contract | Represents legal contracts such as Terms of Service, a License, etc. that specifically are agreed to in the process of performing a submission. |
File | Encapsulates the technical metadata of a finite, ordered, stream of binary digits that are contained within the bag payload directory. An Article may link to a File representing its content, supporting figures, tables, or data. Represents the binary files and their roles associated with an Article. These would be considered part of the custodial content of a package. |
Journal | Encapsulates a Journal and its metadata. Metadata describing a Journal in print and/or electronic form |
Organization | Represents an entity unified by management, vision, or legal framework that may act as an agent. Represents an organization related to the research or funding of the Article |
Person | Represents an individual agent that contributed to the Submission in some way. Accounts for people and their roles. |
Publication | Represents the Article in the context of a printed publication. |
Submission | Aggregates the entities of the Resource Model as a cohesive whole and provides a place to record provenance detail. Represents a submission to an agency, containing the Article, Data Files, Award information, people involved in the submission process, and any agreements or contracts signed as part of the submission. |
Agreement
Encapsulates any and all form of agreement or contract related to the Submission, Article, or Data Files
| Field Name |
JSON-LD Field Name |
JSON-LD Type |
JSON Type |
Description |
| Agreement Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this Agreement entity within the resource model of the package. |
| Agreement Entity Type |
@type |
IRI |
string |
A fixed value: "Agreement" |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
Signatory (a Person) |
signatory |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The individual who is agreeing to the Contract associated with this Agreement. |
| Effective Date |
effective-date |
Value Object (xsd:dateTime) |
string |
The date a license is granted, copyright is claimed, or terms of use agreed upon. |
| Role |
contract-role |
Value Object |
string |
The role of the Contract associated with the Agreement (e.g. a "Terms of Service", "License", etc.) |
Contract (a Contract) |
contract |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The terms of use agreed upon, license being granted, or other contract. |
Article
Represents the Author Accepted Manuscript or Published Article. The primary intellectual output captured by a Submission.
| Conceptual Field |
JSON-LD Field Name |
JSON-LD Field Type |
JSON Type |
Description |
| Article Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this Article entity within the resource model of the package. |
| Article Entity Type |
@type |
IRI |
string |
A fixed value: "Article" |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
| Title |
title |
Value Object |
string |
The title of this Article |
| Abstract |
abstract |
Value Object |
string |
The abstract of this Article |
| DOI |
doi |
Value Object |
string |
The DOI of the published version of this Article. Note that this value should not encode the DOI as a URI. |
| PubMed ID |
pubmedId |
Value Object |
string |
The PubMed identifier of this Article |
| PMC ID |
pmcId |
Value Object |
string |
The PubMed Central identifier of this Article |
| CrossRef ID |
crossrefId |
Value Object |
string |
The CrossRef identifier of this Article |
| PII |
pii |
Value Object |
string |
The Publisher Item Identifier of this Article |
Authors (each is a Person) |
authors |
Array containing IRIs and/or Node Objects |
Array of string or object |
The Authors of this Article |
Publications (each is a Publication) |
publications |
Array containing IRIs and/or Node Objects |
Array of string or object |
For example the electronic publication and the print publication. |
Awards (each is an Award) |
awards |
Array containing IRIs and/or Node Objects |
Array of string or object |
Funding that contributed to intellectual content of this Article or associated Files |
Files (each is a File) |
files |
Array containing IRIs and/or Node Objects |
Array of string or object |
Data files for the submission, including the manuscript and any supplementary data. |
Award
The award or awards that funded the research represented in the Article or data files.
| Conceptual Field |
JSON-LD Field Name |
JSON-LD Field Type |
JSON Type |
Description |
| Award Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this Award entity within the resource model of the package. |
| Award Entity Type |
@type |
IRI |
string |
A fixed value: "Award" |
| DOI |
doi |
Value Object |
string |
The DOI identifying this Award |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
| Award Name |
award-name |
Value Object |
string |
The name or title of this Award |
| Agency Award Number |
agency-award-number |
Value Object |
string |
The alpha-numeric string assigned by the funding agency to this Award |
Funding Agency (an Organization) |
sponsor |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The Organization which funded this Award |
| Award Start |
award-start |
Value Object |
string |
The date the funding for this Award started |
| Award End |
award-end |
Value Object |
string |
The date the funding for this Award ended, or will end |
PI (a Person) |
pi |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The Principal Investigator for this Award |
Co-Is (a Person) |
cois |
Array containing IRIs and/or Node Objects |
Array of string or object |
Any Co-Investigators for this Award |
Award Contact (a Person) |
award-contact |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The institutional contact for this Award |
Contract
Encapsulates any and all form of agreement or contract related to the Submission, Article, or Data Files
| Conceptual Field Name |
JSON-LD Field Name |
JSON-LD Field Type |
JSON Type |
Description |
| Contract Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this Contract entity within the resource model of the package. |
| Contract Entity Type |
@type |
IRI |
string |
A fixed value: "Contract" |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
| Name |
contract-name |
Value Object |
string |
A name for this Contract |
| Description |
contract-description |
Value Object |
string |
Short, human-readable description of the agreement, licence, or terms of use. |
| Full Text |
contract-text |
Value Object |
string |
The full text of the agreement, license, or terms of use. |
| Canonical Location |
contract-location |
Value Object (xsd:anyURI) |
string |
The canonical location of the full text of this Contract. For example, the location of the legal text of the CC-0 license or ASF 2.0 license. |
| See Also |
see-also |
Value Object (xsd:anyURI) |
string |
The splash page, or layperson equivalent view of an agreement, licence, or terms of use. For example, the CC-0 splash page or ASF 2.0 splash-page. |
File
Represents the binary files and their roles associated with an Article. These would be considered part of the custodial content of a package.
| Conceptual Field |
JSON-LD Field Name |
JSON-LD Field Type |
JSON Type |
Description |
| File Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this File entity within the resource model of the package. |
| File Entity Type |
@type |
IRI |
string |
A fixed value: "File" |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
| Roles |
file-roles |
Value Object |
Array of string |
E.g. Manuscript, Supplement, Figure, Table |
| Name |
file-name |
Value Object |
string |
The logical file name |
| Path |
file-path |
Value Object |
string |
The logical file path |
| Location |
location |
Value Object |
string |
The physical location of the file within the package. This value is relative to the base directory of the bag. |
| Canonical Location |
canonical-location |
Value Object (xsd:anyURI) |
string |
The canonical location resolving to the bytes of this file |
| Checksums |
checksums |
Value Object |
Array of string |
Checksums of the file content, in the form \<algorithm\>:\<value\> |
| Media Type |
media-type |
Value object |
string |
The IANA media type of the file (e.g. application/pdf) |
| Size |
size-bytes |
Value object |
number |
The length of this File in bytes |
Journal
Metadata describing a Journal in print and/or electronic form
| Conceptual Field Name |
JSON-LD Field Name |
JSON-LD Type |
JSON Type |
Description |
| Journal Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this Journal entity within the resource model of the package. |
| Journal Entity Type |
@type |
IRI |
string |
A fixed value: "Journal" |
| NLM Journal ID |
journal-id-nlm |
Value Object |
string |
The NLM Journal ID for this Journal. |
| NLM Title Authority Abbreviation |
journal-id-nlmta |
Value Object |
string |
The NLM title authority abbreviation for this Journal. |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
| Title |
journal-title |
Value Object |
string |
The Journal title. |
| Electronic ISSN |
issn-electronic |
Value Object |
string |
The ISSN of the electronic version of this Journal. |
| Print ISSN |
issn-print |
Value Object |
string |
The ISSN of the print version of this Journal. |
| Linking ISSN |
issn-linking |
Value Object |
string |
The Linking ISSN for this Journal. |
| Publisher Name |
publisher-name |
Value Object |
string |
The name of the Journal publisher. |
Organization
Represents an organization related to the research or funding of the Article
| Conceptual Field Name |
JSON-LD Field Name |
JSON-LD Field Type |
JSON Type |
Description |
| Organization Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this Organization entity within the resource model of the package. |
| Organization Entity Type |
@type |
IRI |
string |
A fixed value: "Organization" |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
| Name |
organization-name |
Value Object |
string |
The name of this Organization |
| SciVal Organization ID |
scivalId |
IRI |
string |
The Elsevier SciVal identifier for this Organization |
| RoR ID |
rorId |
IRI |
string |
Resource Organization Registry Identifier for this Organization |
| GRID ID |
gridId |
IRI |
string |
Global Research Identifier for this Organization |
| ISNI ID |
isniId |
IRI |
string |
International Standard Name Identifier for this Organization |
| Crossref ID |
crossrefId |
IRI |
string |
CrossRef ID for this Organization |
| NIH Institution Profile File |
ipf |
Value Object |
string |
The NIH IPF number for this Organization |
| DUNS Number |
duns |
Value Object |
string |
The Dun & Bradstreet number for this Organization |
| Geographic Coordinates |
geo-location |
IRI |
string |
The VCard Geo URI for this Organization (e.g. "geo:39.3299054,-76.6227064") |
| Street Address |
street-address |
Value Object |
string |
The street address of this Organization |
| Locality (i.e. City) |
locality |
Value Object |
string |
The locality (i.e. City) of this Organization |
| Region (i.e. State) |
region |
Value Object |
string |
The region (i.e. State) of this Organization |
| Country |
country-name |
Value Object |
string |
The country of this Organization |
| Postal Code |
postal-code |
Value Object |
string |
The postal code (i.e. zip code) of this Organization |
Person
Accounts for people and their roles
| Conceptual Field |
JSON-LD Field Name |
JSON-LD Field Type |
JSON Type |
Description |
| Person Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this Person entity within the resource model of the package. |
| Person Entity Type |
@type |
IRI |
string |
A fixed value: "Person" |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
| First Name |
given-name |
Value Object |
string |
The first, or given, name of this Person |
| Last Name |
family-name |
Value Object |
string |
The last name of this Person |
Affiliation (an Organization) |
affiliation |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The Organization this Person is affiliated with. |
| Phone |
phone |
Value Object |
string |
The phone number of this Person |
| Email |
email |
Value Object |
string |
The primary email address of this Person |
| ORCID |
orcid |
IRI |
string |
The ORCID of this Person encoded as an IRI |
Publication
Represents the Article in the context of its publication
| Conceptual Field |
JSON-LD Field Name |
JSON-LD Field Type |
JSON Type |
Description |
| Publication Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this Publication entity within the resource model of the package. |
| Publication Entity Type |
@type |
IRI |
string |
A fixed value: "Publication" |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
| Volume |
volume |
Value Object |
string |
The volume of the Journal this Publication appears in. |
| Issue |
issue |
Value Object |
string |
The issue of the Journal this Publication appears in. |
| Page Start |
page-start |
Value Object |
string |
The starting page of this Publication in the Journal |
| Page End |
page-end |
Value Object |
string |
The ending page of this Publication in the Journal |
| Electronic Publication Date |
publication-date-electronic |
Value Object (xsd:dateTime) |
string |
The date this Publication was made available electronically |
| Print Publication Date |
publication-date-print |
Value Object (xsd:dateTime) |
string |
The date this Publication was made available in print |
Journal (a Journal) |
journal |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The Journal this Publication was published in |
Submission
Represents a submission to an agency, containing the Article, Data Files, Award information, people involved in the submission process, and any agreements or contracts signed as part of the submission.
| Conceptual Field |
JSON-LD Field Name |
JSON-LD Field Type |
JSON Type |
Description |
| Submission Identifier |
@id |
IRI |
string |
An identifier supplied by the agent creating the package. The identifier is an opaque IRI that uniquely identifies this Submission entity within the resource model of the package. |
| Submission Entity Type |
@type |
IRI |
string |
A fixed value: "Submission" |
| Identifiers |
identifiers |
Value Object |
Array of string |
Arbitrary identifiers that are not otherwise defined in the data model. |
| Correlation Identifier |
correlation-id |
Value Object |
string |
An identifier supplied by the sender of the package used for the express purpose of correlating information present in the model with agency records. For example, this would be an identifier suitable for NIH Public Access Compliance Monitor (PACM) exports. |
Article (an Article) |
article |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The Article describes the intellectual (i.e. custodial) content of the Submission. A Submission must contain exactly one Article. |
Award (an Award) |
awards |
Array containing IRIs and/or Node Objects |
Array of string or object |
Awards from funding agencies that support the research manifested in the Submission. |
Custodial Contact (a Person) |
custodial-contact |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The administrative contact for custodial content of this submission. This individual would complete the submission in an agency system, or address mistakes made in the content of the submission (e.g. errors in the article or supporting data). The Custodial Contact and the Submitter will often be the same individual, but may be an individual who has prepared the Submission on behalf of the researcher. As opposed to the Infrastructure Contact, who is the contact for the IT infrastructure that created the Submission. |
Submitter (a Person) |
submitter |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The individual responsible for performing the submission; typically the same individual who is the signatory on any Agreements present in the Submission. |
Agreements (each is an Agreement) |
agreements |
Array containing IRIs and/or Node Objects |
Array of string or object |
Agreements signed as part of the submission process or workflow. |
| Creation Date |
created-date |
Value Object (xsd:dateTime) |
string |
The date and time this Submission was created. |
| Description |
submission-description |
Value Object |
string |
A brief, human-readable, description of the Submission and its provenance. |
Infrastructure Contact (a Person) |
infrastructure-contact |
Array containing IRIs and/or Node Objects |
Array containing strings and/or objects |
The person or agent responsible for creating the bag and the resource model (e.g. a system administrator or software program). As opposed to the Custodial Contact who is responsible for the intellectual content contained within the Submission, and the Submitter who is responsible for performing the Submission. |