Lexicon Garden

tech.transparencia.document.item

Core document metadata for official and institutional documents. Stores identity, provenance, and public context, but not full text, sections, chunks, AI analysis, or ingestion pipeline state.

Repository @transparencia.pds.transparencia.tech did:plc:top57c5tklg2fjl66hpidi45 namespace authority
Details · record, key tid
Kindrecord
Record keytid
Authoritydocument.transparencia.tech
Indexed
Compare Edit in builder → Fork →

Record

record · key tid

Properties

country

string

Primary country connected to the document, as an ISO 3166-1 alpha-2 code (e.g., 'MX', 'BR', 'US'). Omit for international documents.

  • maxLength: 2

createdAt

requiredstring · datetime

When this AT Protocol record was created.

description

string

Short source-provided description or human-readable abstract. AI summaries should be stored in enrichment records.

  • maxLength: 10000
  • maxGraphemes: 2000

documentType

requiredstring

Machine-readable document category. Open set; known values cover common official and institutional documents.

  • maxLength: 128
  • knownValues: official-publication | official-gazette-issue | official-gazette-entry | law | decree | agreement | notice | regulation | standard | report | audit-report | budget-document | contract | procurement-document | court-ruling | legislative-bill | legislative-opinion | treaty | submission | technical-paper | environmental-impact-document | education-policy-document | dataset-documentation | meeting-minutes | resolution | other

domains

array

Broad public-interest domains covered by the document. Open set; consumers should tolerate unknown values.

  • maxLength: 20
itemsstring
  • maxLength: 128
  • maxGraphemes: 64
  • knownValues: government | politics | law | justice | environment | climate | education | health | budget | procurement | economy | finance | labor | energy | infrastructure | security | science-technology | society | human-rights | other

effectiveAt

string · datetime

When the document's legal or administrative effects begin, if applicable and explicitly known.

identifiers

array

External identifiers such as DOF IDs, UNFCCC symbols, file numbers, docket numbers, ISBNs, or local archival IDs. For content hashes use retrieval.sha256; for URLs use retrieval.url.

  • maxLength: 50
itemsref
Reference

issuedAt

string · datetime

When the issuing authority signed, issued, adopted, or approved the document, if different from publication time.

issuingBodies

array

Organizations, public bodies, institutions, or authorities responsible for issuing, publishing, filing, or adopting the document. Uses the shared tech.transparencia.defs#organization type. Conventional role values include 'publisher', 'issuer', 'author', 'adopter', 'filer', 'regulator', 'court', 'legislature', 'repository'.

  • maxLength: 20

jurisdiction

string

Legal or administrative jurisdiction covered by the document (e.g., 'federal', 'state', 'municipal', 'international').

  • maxLength: 256
  • maxGraphemes: 64
  • knownValues: local | municipal | state | federal | national | regional | international | supranational | unknown

language

string · language

Primary language of the document content (BCP-47, e.g., 'es-MX', 'en', 'pt-BR').

publishedAt

requiredstring · datetime

When the document was published by the source. Use midnight UTC when only a calendar date is available.

retrieval

requiredref

Per-document retrieval metadata: canonical URLs, MIME type, checksums, file size, and access status of the specific retrieved representation.

Reference

source

requiredref

Strong reference to the tech.transparencia.document.source record for the publisher or repository (e.g., DOF, UNFCCC). Identifies which source this document came from.

Reference

subtitle

string

Optional subtitle, section heading, or secondary title.

  • maxLength: 4096
  • maxGraphemes: 1024

title

requiredstring

Official or source-provided title of the document.

  • maxLength: 4096
  • maxGraphemes: 1024

topics

array

Free-form topics, tags, or source categories attached to the document.

  • maxLength: 30
itemsstring
  • maxLength: 512
  • maxGraphemes: 128

updatedAt

string · datetime

When this record was last materially updated.

#identifier

object

External identifier assigned to a document by a source system, authority, archive, or standard. For content hashes use retrieval.sha256; for URLs use retrieval.url.

Properties

type

requiredstring

Identifier type or namespace.

  • maxLength: 128
  • knownValues: dof_id | dof_publication_id | unfccc_symbol | official_file_number | docket_number | case_number | law_number | isbn | issn | doi | other

url

string · uri

Optional URL where this identifier can be resolved or verified.

value

requiredstring

Identifier value.

  • maxLength: 1024
  • maxGraphemes: 256

#retrieval

object

Per-document retrieval metadata for a single retrieved representation. Publisher-level metadata (name, base URL, license) lives on the tech.transparencia.document.source record referenced by 'source'.

Properties

accessType

string

Access status of the source at retrieval time. Use 'previously-public' for documents that were once publicly accessible but have since been withdrawn or removed by the source.

  • maxLength: 64
  • knownValues: public | restricted | paywalled | previously-public | unknown

blob

blob

Optional binary attachment preserving the actual document bytes on this PDS. Typical contents: the source PDF, an HTML snapshot, the extracted plain text used by the enrichment pipeline, or the original upstream JSON payload (e.g., a SIDOF response). The other retrieval fields (url, pdfUrl, sha256) still reference the original public source — this blob is the archived copy. Max 50 MB.

  • maxSize: 50000000
  • accept: application/pdf, text/html, text/plain, application/json

canonicalUrl

string · uri

Canonical, normalized, or preferred public URL for the document.

fileName

string

Original or normalized file name, if applicable.

  • maxLength: 1024
  • maxGraphemes: 256

htmlUrl

string · uri

HTML landing page or web version of the document, if available.

license

string

Per-document license override, if the document is licensed differently from the source-level default.

  • maxLength: 512
  • maxGraphemes: 128

mimeType

string

MIME type of the retrieved representation (e.g., 'text/html', 'application/pdf').

  • maxLength: 128

pdfUrl

string · uri

PDF or downloadable document URL, if available.

retrievedAt

requiredstring · datetime

When the source was retrieved by the pipeline.

sha256

string

SHA-256 checksum of the retrieved file or canonical source payload, if available.

  • maxLength: 64

sizeBytes

integer

Size of the retrieved file or canonical representation in bytes.

  • minimum: 0

sourceId

string

Source-system identifier for deduplication, if provided by the upstream source.

  • maxLength: 512

url

requiredstring · uri

URL where this document was found or retrieved.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • tech.transparencia.document.source

    record

    A document source: an official gazette, government repository, institutional archive, court system, registry, or other publisher of public-interest documents tracked by TransparencIA.

  • tech.transparencia.document.mxdof.note

    record

    DOF-specific sidecar for a Diario Oficial de la Federación (México) nota. Captures gazette-specific identifiers, edition, section, and authority hierarchy that don't fit the universal tech.transparencia.document.item record. Each nota in the DOF SIDOF feed maps to one record of this lexicon plus one underlying document.item record.

  • tech.transparencia.document.mxdof.note.enrichment

    record

    AI- or analyst-generated enrichment attached to a Diario Oficial de la Federación (México) nota. Captures legal and administrative semantics — type of act, document class, legal effects, obligations, compliance items, related references — while also exposing cross-domain fields (contentDomain, eventType, region) so DOF and news enrichments can be analyzed together.

  • com.tituslegaldesign.immigration.sourceSnapshot

    record

    A point-in-time capture of an upstream source publication: ICE's participating-agencies workbook, a FOIA production, or a roster PDF. Agreement events reference the snapshot that justified them, so every published change traces back to an archived, content-addressed copy of the document it came from. Record key is a TID. Snapshots are never updated or deleted; a revised upstream file is a new snapshot.