Property 1: Identifier

Persistent identifiers for DOCiD™ publications - DOI, Handle, DOCiD, and other PIDs
1. Identifier
Required Occurrences: 1

Definition: DOCiD™ generates and manages multiple persistent identifiers (PIDs) for each publication, ensuring global uniqueness and long-term accessibility.

Primary Identifier Generation:

DOCiD™ automatically generates a unique identifier using the format: 20.500.14351/[unique-hash] where 20.500.14351 is the APA Handle prefix.

Supported Identifier Types:

  • DOCiD™: Internal identifier format (20.500.14351/xxxxx)
  • APA Handle ID: African PID Alliance Handle Service
  • DOI: Digital Object Identifier via Crossref/DataCite
  • Handle: Handle System identifier via APA
  • Hand iD: Handle System identifier via Hand iD
  • dPID: Distributed Persistent Identifier
  • CSTR: China Science Technology Resource System
  • ARK: Archival Resource Key
  • URN: Uniform Resource Name

Database Implementation:

The Publications model stores primary identifiers with additional identifiers tracked in related tables:

Publications Model - Identifier Fields
class Publications(db.Model):
    __tablename__ = 'publications'

    # Primary database identifier
    id = Column(Integer, primary_key=True, autoincrement=True)

    # DOCiD™ specific identifier (Handle format: 20.500.14351/xxxxx)
    document_docid = Column(String(255), nullable=False, unique=True)

    # DOI identifier (optional, assigned via Crossref)
    doi = Column(String(50), nullable=True)

    # CSTR identifier (optional, via CSTR service)
    cstr_identifier = Column(String(255), nullable=True)

    # Timestamps for identifier assignment
    docid_assigned_date = Column(DateTime, default=datetime.utcnow)
    doi_assigned_date = Column(DateTime, nullable=True)

Sub-properties

1.1 identifierType
Required Occurrences: 1

Definition: The type of identifier.

Identifier Types in DOCiD™ System:

  • APA Handle ID (Primary): Format 20.500.14351/xxxxx - Generated automatically
  • DOI: Digital Object Identifier - Assigned via Crossref/DataCite integration
  • CSTR: China Science and Technology Resource - For Chinese research outputs
  • ARK: Archival Resource Key - For long-term preservation
  • ORCID: For creator identification (0000-0000-0000-0000)
  • ROR: For organization identification (https://ror.org/xxxxx)
  • RAiD: For project identification (10.80368/xxxxx)

Real Examples from DOCiD™ System:

Actual Identifier Formats
# APA Handle ID (Primary DOCiD)
20.500.14351/b1f26969fdec417b55c6
20.500.14351/b23a80ce9b1a6ef21588

# DOI (via Crossref)
https://doi.org/10.5555/africa.2024.001

# CSTR Identifier
CSTR:16389.09.A08V-0001

# ORCID (Creator)
0000-0002-1981-4157

# ROR (Organization)
https://ror.org/00dzfmv17

# RAiD (Project)
https://app.demo.raid.org.au/raids/10.80368/b1adfb3a

API Implementation

Identifier Assignment During Publication
POST /api/v1/publications/assign-docid
Authorization: Bearer {jwt_token}
Content-Type: application/json

{
    "publication_type_id": 1,  # Article
    "documents": [{
        "title": "Traditional Medicine Knowledge Systems",
        "description": "Comprehensive study of healing practices",
        "identifier_type": "APA Handle ID",
        "file_path": "/uploads/2024/doc001.pdf"
    }],
    "creators": [{
        "orcid_id": "0000-0002-1981-4157",
        "role_id": 3  # Researcher
    }],
    "organizations": [{
        "ror_id": "00dzfmv17",
        "country": "Kenya"
    }],
    "funders": [{
        "ror_id": "0456r8d26",
        "name": "Gates Foundation"
    }],
    "projects": [{
        "raid_id": "10.80368/b1adfb3a",
        "title": "AFRICA PID ALLIANCE DOCID"
    }]
}

# Response includes generated identifier
{
    "status": "success",
    "data": {
        "document_docid": "20.500.14351/b1f26969fdec417b55c6",
        "message": "Publication added Successfully"
    }
}
Identifier Resolution Endpoint
GET /api/v1/publications/docid/DOCID.AFRICA.2024.001
Authorization: Bearer {jwt_token}

Response:
{
    "status": "success",
    "data": {
        "id": 1,
        "document_docid": "DOCID.AFRICA.2024.001",
        "doi": "10.5555/docid.2024.001",
        "document_title": "Traditional Medicine Knowledge Systems in Southern Africa",
        "identifiers": [
            {
                "type": "DOI",
                "value": "https://doi.org/10.5555/docid.2024.001",
                "is_primary": true
            },
            {
                "type": "Handle", 
                "value": "https://hdl.handle.net/20.500.12345/12345",
                "is_primary": false
            }
        ]
    }
}

African Research Examples

Resource Type Primary Identifier Alternate Identifiers Institution
Image 20.500.14351/b1f26969fdec417b55c6 APA Handle ID
Auto-generated		 Training Centre in Communication
Article 20.500.14351/b23a80ce9b1a6ef21588 DOI: 10.5555/africa.2024.001
CSTR: Pending		 Africa PID Alliance
Dataset 20.500.14351/c45def89a2b1234567 ARK: ark:/12345/b4567
DOI: Pending		 Kenya Medical Research Institute
Preprint 20.500.14351/d56ghi01b3c4567890 arXiv: 2024.12345
DOI: Reserved		 African Institute of Mathematical Sciences
External Services 2. Creator