glam/schemas/20251121/linkml/modules/classes/Notes.yaml
kempersc b13674400f Refactor schema slots and classes for improved organization and clarity
- Removed deprecated slots: appraisal_notes, branch_id, is_or_was_real.
- Introduced new slots: has_or_had_notes, has_or_had_provenance.
- Created Notes class to encapsulate note-related metadata.
- Archived removed slots and classes in accordance with the new archive folder convention.
- Updated slot_fixes.yaml to reflect migration status and details.
- Enhanced documentation for new slots and classes, ensuring compliance with ontology alignment.
- Added new slots for note content, date, and type to support the Notes class.
2026-01-14 12:14:07 +01:00

122 lines
3.8 KiB
YAML

# Notes class
# Generic class for typed notes with provenance
#
# Generation date: 2026-01-14
# Rule compliance: 0 (LinkML single source of truth), 38 (slot centralization)
# Migration: Supports has_or_had_notes slot (replaces appraisal_notes)
id: https://nde.nl/ontology/hc/class/Notes
name: notes_class
title: Notes Class
prefixes:
linkml: https://w3id.org/linkml/
hc: https://nde.nl/ontology/hc/
skos: http://www.w3.org/2004/02/skos/core#
rdfs: http://www.w3.org/2000/01/rdf-schema#
schema: http://schema.org/
dcterms: http://purl.org/dc/terms/
default_prefix: hc
imports:
- linkml:types
- ../metadata
- ../slots/note_type
- ../slots/note_content
- ../slots/note_date
- ../slots/language
- ../slots/specificity_annotation
- ../slots/template_specificity
- ./SpecificityAnnotation
- ./TemplateSpecificityScores
classes:
Notes:
class_uri: skos:note
description: |
A typed note with optional provenance metadata.
**Purpose**:
Notes provides a reusable class for representing documentation notes
across the heritage custodian schema. Supports typed notes (appraisal,
arrangement, conservation, etc.) with language tagging and dates.
**Ontological Alignment**:
- **Primary**: `skos:note` - general note
- **Close**: `rdfs:comment` - comment on resource
**Use Cases**:
- Appraisal notes documenting retention decisions
- Arrangement notes documenting physical organization
- Conservation notes documenting treatments
- Processing notes documenting archival workflow
- General documentation notes
**Replaces**:
- `appraisal_notes` (string) - now typed with note_type
exact_mappings:
- skos:note
close_mappings:
- rdfs:comment
- dcterms:description
slots:
- note_type
- note_content
- note_date
- language
- specificity_annotation
- template_specificity
slot_usage:
note_type:
description: |
The type of note (appraisal, arrangement, conservation, processing, general).
range: string
required: false
examples:
- value: appraisal
description: Appraisal decision documentation
- value: arrangement
description: Physical organization notes
- value: conservation
description: Treatment documentation
note_content:
description: The textual content of the note.
range: string
required: true
note_date:
description: Date the note was created or last updated.
range: date
required: false
language:
description: |
ISO 639-1 two-letter language code for this note.
Examples: "en", "nl", "de", "fr"
range: string
required: false
pattern: "^[a-z]{2}$"
annotations:
custodian_types: '["*"]'
custodian_types_rationale: Generic notes class applicable to all types.
custodian_types_primary: null
specificity_score: 0.3
specificity_rationale: Broadly applicable generic class for documentation notes.
examples:
- value: |
note_type: appraisal
note_content: "Retained all policy files; destroyed duplicate copies and routine correspondence per retention schedule RS-2020-05"
note_date: "2024-03-15"
language: en
description: "Appraisal note documenting retention decisions"
- value: |
note_type: arrangement
note_content: "Maintained original order by correspondent. Created 5 series by function. Rehoused into acid-free folders and boxes."
note_date: "2024-06-01"
language: en
description: "Arrangement note documenting physical organization"