Skip to content

Commit

Permalink
Consolidate Agent identifiers (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
chenejac committed Oct 11, 2023
1 parent 1d5834f commit e45f680
Show file tree
Hide file tree
Showing 13 changed files with 118 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ for instance the [ORCID Identifier](./entities/ORCID_Identifier.md).
* [ROR ID Type](./datatypes/ROR_ID.md)
* [URI Type](./datatypes/URI.md)
* [DOI Type](./datatypes/DOI.md)
* [Fundref ID Type](./datatypes/Fundref_ID.md)
* [Fundref ID Type](./datatypes/FundRef_ID.md)
* [ISNI ID Type](./datatypes/ISNI_ID.md)
* [Wikidata ID Type](./datatypes/Wikidata_ID.md)
* [Person Name](./datatypes/Person_Name.md)
Expand Down
2 changes: 1 addition & 1 deletion datatypes/Fundref_ID.md → datatypes/FundRef_ID.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The Fundref ID datatype
# The FundRef ID datatype

The datatype that represents [Funder registry](https://www.crossref.org/services/funder-registry/) entries.

Expand Down
2 changes: 1 addition & 1 deletion datatypes/ORCID_iD.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ORCID iD Type

The datatype that represents the [ORCID](https://orcid.org/) identifier.
The datatype that represents the [ORCID identifier](../entities/ORCID_Identifier.md).

It is based on the [String](../datatypes/String.md) datatype with the following restriction:
- the string must match one of the following regular expressions:<sup>[1](#fn1)</sup>
Expand Down
8 changes: 8 additions & 0 deletions datatypes/Scopus_Author_ID.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Scopus Author ID Type

The datatype that represents the [Scopus Author identifier](../entities/Scopus_Author_Identifier.md).

It is based on the [Decimal](../datatypes/Decimal.md) datatype with the following restriction:
- it is a positive integer usually with 10 or 11 digits


4 changes: 0 additions & 4 deletions entities/Agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ description: [Multilingual String](../datatypes/Multilingual_String.md)

keywords: List<[Multilingual String](../datatypes/Multilingual_String.md)>

ISNI ID : [ISNI ID Type](../datatypes/ISNI_ID.md)

Wikidata ID : [Wikidata ID Type](../datatypes/Wikidata_ID.md)

lifetime : [Date Range](../datatypes/Date_Range.md)

## Relationships
Expand Down
22 changes: 22 additions & 0 deletions entities/FundRef_Identifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# FundRef Identifier

## Definition
A FundRef<sup>[1](#fn1)</sup> identifier assigned to an [Organisation unit](../entities/Organisation_Unit.md).

## Specialization of
[Agent Identifier](../entities/Agent_Identifier.md)

## Attributes
Besides those of [Agent Identifier](../entities/Agent_Identifier.md):

FundRef ID: [FundFef ID Type](../datatypes/FundRef_ID.md) for organizations that also fund research

## Relationships
None besides those of [Agent Identifier](../entities/Agent_Identifier.md).

## Constraints
A FundRef Identifier can only [be assigned](../entities/Agent_Identifier.md#user-content-rel__is-assigned-to) to an [Organisation](../entities/Organisation_Unit.md) that also fund research, not other subtypes of [Agent](../entities/Agent.md).

---
## References
<a name="fn1">\[1\]</a> *Crossref funder ID*. Wikidata property. Available from https://www.wikidata.org/wiki/Property:P3153
19 changes: 19 additions & 0 deletions entities/ISNI_Identifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# ISNI Identifier

## Definition
An ISNI<sup>[1](#fn1)</sup> identifier assigned to an [Agent](../entities/Agent.md).

## Specialization of
[Agent Identifier](../entities/Agent_Identifier.md)

## Attributes
Besides those of [Agent Identifier](../entities/Agent_Identifier.md):

ISNI ID : [ISNI ID Type](../datatypes/ISNI_ID.md)

## Relationships
None besides those of [Agent Identifier](../entities/Agent_Identifier.md).

---
## References
<a name="fn1">\[1\]</a> What is ISNI? https://isni.org/page/what-is-isni/
2 changes: 1 addition & 1 deletion entities/ORCID_Identifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ An ORCID<sup>[1](#fn1)</sup> identifier assigned to a [Person](../entities/Perso
## Attributes
Besides those of [Agent Identifier](../entities/Agent_Identifier.md):

<a name="DOI">ORCID ID : [ORCID iD Type](../datatypes/ORCID_iD.md)</a>
ORCID ID : [ORCID iD Type](../datatypes/ORCID_iD.md)

## Relationships
None besides those of [Agent Identifier](../entities/Agent_Identifier.md).
Expand Down
4 changes: 0 additions & 4 deletions entities/Organisation_Unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@ acronym: [String](../datatypes/String.md)

address: [Postal Address](../datatypes/Postal_Address.md)

ROR ID: [ROR ID Type](../datatypes/ROR_ID.md)

Fundref ID: [Fundref ID Type](../datatypes/Fundref_ID.md) for organizations that also fund research

web site URL: [URI](../datatypes/URI.md)

email: [URI](../datatypes/URI.md)
Expand Down
6 changes: 2 additions & 4 deletions entities/Person.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ One Person typically has many of these relationships.
## Attributes
name: [Person Name](../datatypes/Person_Name.md)

FIXME - move to ORCID_Identifier
ORCID iD: [ORCID iD](../datatypes/ORCID_iD.md)
ORCID iD: [ORCID Identifier](../entities/ORCID_Identifier.md)

FIXME - move to Scopus_Author_ID_Identifier
Scopus Author ID: [Scopus Author ID](../datatypes/Scopus_Author_ID.md)
Scopus Author ID: [Scopus Author Identifier](../entities/Scopus_Author_Identifier.md)

## Relationships

Expand Down
22 changes: 22 additions & 0 deletions entities/ROR_Identifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# ROR Identifier

## Definition
A ROR<sup>[1](#fn1)</sup> identifier assigned to an [Organisation unit](../entities/Organisation_Unit.md).

## Specialization of
[Agent Identifier](../entities/Agent_Identifier.md)

## Attributes
Besides those of [Agent Identifier](../entities/Agent_Identifier.md):

ROR ID: [ROR ID Type](../datatypes/ROR_ID.md)

## Relationships
None besides those of [Agent Identifier](../entities/Agent_Identifier.md).

## Constraints
A ROR Identifier can only [be assigned](../entities/Agent_Identifier.md#user-content-rel__is-assigned-to) to an [Organisation unit](../entities/Organisation_Unit.md), not other subtypes of [Agent](../entities/Agent.md).

---
## References
<a name="fn1">\[1\]</a> *Facts*. ROR. Available from https://ror.org/facts/
22 changes: 22 additions & 0 deletions entities/Scopus_Author_Identifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Scopus Author Identifier

## Definition
A Scopus Author <sup>[1](#fn1)</sup> identifier assigned to a [Person](../entities/Person.md).

## Specialization of
[Agent Identifier](../entities/Agent_Identifier.md)

## Attributes
Besides those of [Agent Identifier](../entities/Agent_Identifier.md):

Scopus Author Identifier : [Scopus Author ID Type](../datatypes/Scopus_Author_ID.md)

## Relationships
None besides those of [Agent Identifier](../entities/Agent_Identifier.md).

## Constraints
A Scopus Author Identifier can only [be assigned](../entities/Agent_Identifier.md#user-content-rel__is-assigned-to) to a [Person](../entities/Person.md), not other subtypes of [Agent](../entities/Agent.md).

---
## References
<a name="fn1">\[1\]</a> What is the Scopus Author Identifier? https://service.elsevier.com/app/answers/detail/a_id/11212/supporthub/scopus/
19 changes: 19 additions & 0 deletions entities/Wikidata_Identifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Wikidata Identifier

## Definition
A Wikidata<sup>[1](#fn1)</sup> identifier assigned to an [Agent](../entities/Agent.md).

## Specialization of
[Agent Identifier](../entities/Agent_Identifier.md)

## Attributes
Besides those of [Agent Identifier](../entities/Agent_Identifier.md):

Wikidata ID : [Wikidata ID Type](../datatypes/Wikidata_ID.md)

## Relationships
None besides those of [Agent Identifier](../entities/Agent_Identifier.md).

---
## References
<a name="fn1">\[1\]</a> Wikidata:Identifiers, https://www.wikidata.org/wiki/Wikidata:Identifiers

0 comments on commit e45f680

Please sign in to comment.