Skip to content

Source Fields (Layer A)

A Source is the core unit of Layer A — one knowledge source. Every UKS packet has at least one. This page documents every field, exactly as defined in the normative schema.

Required fields

FieldTypeNotes
idstringPacket-scoped identifier (any stable string; UUID v4 recommended)
titlestring (non-empty)The source's title
source_typeenum (extensible)See Source types
credibility_scorenumber 1–10Curator's credibility assessment
evidence_gradeenumSee Evidence grading
clinical_statusenumNever a boolean — see Evidence grading

Optional fields

FieldTypeNotes
urlstring (uri)Canonical URL
source_domainenum (extensible)See Source domains
api_sourcestringAPI/database that returned it (e.g. pubmed, openalex)
summarystringShort summary
key_findingsstring[]Each ≤ 500 chars
tagsstring[]Free-form tags
notestringUser-authored annotation
authorsstring[]
date_publisheddateISO 8601 date
doi · pmid · openalex_idstringStable external identifiers
license_labelstringSPDX id or plain label (e.g. CC BY 4.0) — never collapse with rights_url
rights_urlstring (uri)Link to the license/rights
domain_dataobjectDomain-specific structured data from deep analysis (merge, never overwrite)
raw_dataobjectOriginal API response, preserved verbatim
in_kbbooleanBookmarked to the knowledge base
accessed_atdatetimeWhen fetched
_extensionsobjectEscape hatch — never fails validation

Source types

Extensible knowledge-classification vocabulary. A novel value must be x-/x_ prefixed so consumers treat it as unknown rather than rejecting the packet; a plain unknown value (a typo) is rejected.

research_paper · review_article · meta_analysis · clinical_trial ·
government_report · database_entry · book_chapter · preprint ·
news_article · blog_post · product_page · dataset · api_response ·
patent · standard · other

Source domains

Also extensible (x-/x_ for novel values):

government · geospatial · scientific · bibliographic · cultural_heritage ·
legal · finance · health · open_web · ml · sensors · audio · dsp ·
vst_plugin · general

Additive siblings (optional, backward-compatible)

These extend a source without ever collapsing grading:

  • claims[] — claim-level granularity. Each Claim carries its own statement (required), evidence_grade, clinical_status, confidence (0–1), supports[]/refutes[] (ids), and temporal_validity.
  • temporal_validity — a staleness window: valid_as_of, valid_until, review_due, supersedes[], superseded_by[].
  • quality_dimensions — methodology scoring alongside (never replacing) the GRADE letter: risk_of_bias (low/moderate/high/unclear), directness, consistency, precision, sample_size, replication_status (replicated/partially_replicated/not_replicated/contradicted/unreplicated), conflict_of_interest, study_design, assessment_tool.

Data contracts (Layer A extension)

data_contracts[] formally define named data types in the packet. Each has id, name, and fields[] (FieldDefinition: name, typestring/number/ boolean/array/object/date/datetime/enum/any, plus required, nullable, enum_values, format, example, constraints).

→ Next: Scrape Targets (Layer B) · Evidence Grading

Released under the MIT License.