glam/schemas/20251121/linkml/modules/classes/FindingAid.yaml
kempersc 6c3fa6b5a3 Remove deprecated slots and add new slot definitions for enhanced data modeling
- Deleted obsolete slot definitions for work_location and workshop_space.
- Introduced new TaxonName class to represent scientific taxonomic names with detailed attributes.
- Archived existing slots related to surname_prefix, target_name, taxon_name, terminal_count, text_region_count, title, title_proper, total_chapter, total_characters_extracted, total_connections_extracted, track_name, transcript_format, traveling_venue, type_label, type_status, typical_responsibility, unesco_domain, unesco_inscription_year, unesco_list_status, uniform_title, unit_name, used_by_custodian, uv_filtered_required, valid_from_geo, valid_to_geo, validation_status, variant_of_name, verification_date, viability_status, within_auxiliary_place, and within_place.
- Updated slot descriptions and structures to improve clarity and compliance with standards.
2026-01-15 11:42:35 +01:00

839 lines
21 KiB
YAML

id: https://nde.nl/ontology/hc/class/FindingAid
name: finding_aid_class
title: FindingAid Class
prefixes:
linkml: https://w3id.org/linkml/
hc: https://nde.nl/ontology/hc/
rico: https://www.ica.org/standards/RiC/ontology#
crm: http://www.cidoc-crm.org/cidoc-crm/
bf: http://id.loc.gov/ontologies/bibframe/
skos: http://www.w3.org/2004/02/skos/core#
dcterms: http://purl.org/dc/terms/
schema: http://schema.org/
wd: http://www.wikidata.org/entity/
prov: http://www.w3.org/ns/prov#
foaf: http://xmlns.com/foaf/0.1/
xsd: http://www.w3.org/2001/XMLSchema#
default_prefix: hc
default_range: string
imports:
- linkml:types
- ./FindingAidType
- ./WebClaim
- ./Overview
- ./WebLink
- ../slots/temporal_extent # was: valid_from + valid_to - migrated per Rule 53
- ./TimeSpan
# REMOVED 2026-01-14: valid_from + valid_to - migrated to temporal_extent (Rule 53)
- ../slots/id
- ../slots/description
- ../slots/temporal_coverage
- ../slots/has_or_had_access_restriction
- ../slots/has_or_had_web_claim
- ../slots/language
- ../slots/supersede
- ../slots/superseded_by
- ../slots/revision_date
- ../slots/served_by
- ../slots/retrieval_agent
- ../slots/extraction_note
- ../slots/extraction_method
- ../slots/xpath
- ../slots/css_selector
- ../slots/confidence
- ../slots/html_file
- ../slots/claim_id
- ../slots/claim_type
- ../slots/claim_value
- ../slots/source_url
- ../slots/has_or_had_label # was: title - migrated per Rule 53
- ../slots/date
- ../slots/note
- ../slots/creator
- ../slots/publisher
- ../slots/publication_date
- ../slots/isbn
- ../slots/has_or_had_access_condition
- ../slots/is_or_was_access_restricted
- ../slots/has_or_had_comprehensive_overview
- ../slots/card_description
- ../slots/card_description_en
- ../slots/card_image_url
- ../slots/card_title
- ../slots/card_title_en
- ../slots/card_url
- ../slots/claims_count
- ../slots/colonial
- ../slots/content_block
- ../slots/crawler_version
- ../slots/custodian
- ../slots/date_retrieved
- ../slots/de
- ../slots/ead_id
- ../slots/en
- ../slots/end
- ../slots/has_or_had_external_resource
- ../slots/has_or_had_featured_item
- ../slots/finding_aid_note
- ../slots/finding_aid_scope_note
- ../slots/has_or_had_type
- ../slots/format
- ../slots/fr
- ../slots/full_name
- ../slots/geographic_coverage
- ../slots/ghcid
- ../slots/heading_level
- ../slots/heading_text
- ../slots/heading_text_en
- ../slots/historical_region
- ../slots/html_snapshot_path
- ../slots/inbound_from
- ../slots/international
- ../slots/is_sub_guide
- ../slots/isil
- ../slots/has_or_had_key_archive
- ../slots/has_or_had_key_date
- ../slots/has_or_had_key_period
- ../slots/link_context
- ../slots/link_text
- ../slots/link_type
- ../slots/link_url
- ../slots/list_item
- ../slots/location
- ../slots/major_city
- ../slots/name
- ../slots/nl
- ../slots/outbound_to
- ../slots/has_or_had_page_section
- ../slots/period
- ../slots/period_description
- ../slots/period_end
- ../slots/period_name
- ../slots/period_start
- ../slots/has_or_had_period
- ../slots/permission_required
- ../slots/primary
- ../slots/provenance
- ../slots/related
- ../slots/has_or_had_related_archive
- ../slots/has_or_had_related_guide
- ../slots/relationship
- ../slots/resource_description
- ../slots/restriction_description
- ../slots/restriction_type
- ../slots/scope
- ../slots/secondary
- ../slots/section_id
- ../slots/has_or_had_section_link
- ../slots/slug
- ../slots/specificity_annotation
- ../slots/start
- ../slots/sub_guide_description
- ../slots/sub_guide_temporal_coverage
- ./SubGuideType
- ../slots/has_or_had_sub_guide
- ../slots/has_or_had_sub_section
- ../slots/template_specificity
# REMOVED: ../slots/title_en - migrated to has_or_had_label with Label (2026-01-14, Rule 53)
# REMOVED: ../slots/title_nl - migrated to has_or_had_label with Label (2026-01-14, Rule 53)
- ../slots/has_or_had_label
- ./Label
- ../slots/topic
- ../slots/type
- ../slots/url
# REMOVED 2026-01-14: ../slots/validation_status - migrated to has_or_had_status with ValidationStatus
- ../slots/has_or_had_status
- ./ValidationStatus
- ../slots/wikidata
# REMOVED: ../slots/wikidata_class - migrated to is_or_was_instance_of with WikiDataEntry (2026-01-14, Rule 53)
- ../slots/is_or_was_instance_of
- ./WikiDataEntry
- ../slots/has_or_had_restriction
- ./Restriction
- ./FindingAid
- ./PersonWebClaim
- ./SpecificityAnnotation
- ./TemplateSpecificityScores
- ./TimeSpan
- ../slots/finding_aid_description
- ../slots/finding_aid_temporal_coverage
- ../slots/finding_aid_access_restriction
- ../slots/has_link
- ../slots/event
- ../slots/event_en
- ../slots/claim_source_url
- ../enums/ExternalResourceTypeEnum
- ../enums/SubGuideTypeEnum
- ../enums/RelationshipTypeEnum
- ../enums/LinkTypeEnum
classes:
FindingAid:
class_uri: rico:FindingAid
description: 'A finding aid - a descriptive tool that establishes intellectual and physical
control over heritage materials by describing them and facilitating access.
**DEFINITION** (RiC-O):
"A finding aid is a set of descriptions that identifies, locates, summarizes,
and indexes materials in a record-holding organization, typically archives,
libraries, or museums."
This class captures the descriptive metadata for finding aids produced by
heritage custodians to facilitate access to their collections. It supports:
- Multilingual titles and descriptions (nl, en, etc.)
- Classification via FindingAidType hierarchy
- Custodian linkage via GHCID, ISIL, Wikidata
- Topic/subject indexing
- Temporal and geographic coverage
- References to sub-guides and external resources
- Key archives and related archives
- Related guides within the repository
- Provenance tracking for web-harvested data
- Page structure with web claims and XPath provenance
- RiC-O: rico:FindingAid
- Dublin Core: dcterms:BibliographicResource
- Schema.org: schema:CreativeWork
- CIDOC-CRM: crm:E31_Document
- BIBFRAME: bf:Work
**EXAMPLE FILES**:
See data/custodian/findingaid/NL-ZH-DHA-A-NA/guide/repository_guide/metadata/
'
exact_mappings:
- rico:FindingAid
close_mappings:
- dcterms:BibliographicResource
- schema:CreativeWork
- crm:E31_Document
- bf:Work
slots:
- finding_aid_access_restriction
- has_or_had_comprehensive_overview
- creator
- custodian
- finding_aid_description
- ead_id
- has_or_had_external_resource
- finding_aid_note
- has_or_had_type
- format
- geographic_coverage
- id
- isbn
- has_or_had_key_archive
- language
- note
- has_or_had_page_section
- provenance
- publication_date
- publisher
- has_or_had_related_archive
- has_or_had_related_guide
- revision_date
- finding_aid_scope_note
- served_by
- slug
- specificity_annotation
- has_or_had_sub_guide
- superseded_by
- supersede
- template_specificity
- finding_aid_temporal_coverage
- has_or_had_label # was: title
- topic
- url
- temporal_extent # was: valid_from + valid_to - migrated per Rule 53
- has_or_had_web_claim
# REMOVED: wikidata_class - migrated to is_or_was_instance_of with WikiDataEntry (2026-01-14, Rule 53)
- is_or_was_instance_of
slot_usage:
id:
identifier: true
required: true
slug:
required: true
has_or_had_type:
required: true
range: FindingAidType
description: |
The type classification of this finding aid.
Uses FindingAidType class hierarchy.
has_or_had_label: # was: title
required: true
url:
required: true
custodian:
required: true
finding_aid_description:
range: MultilingualText
inlined: true
finding_aid_temporal_coverage:
range: TemporalCoverage
inlined: true
finding_aid_access_restriction:
range: AccessRestriction
multivalued: true
inlined_as_list: true
has_or_had_web_claim:
range: WebClaim
multivalued: true
inlined_as_list: true
language:
multivalued: true
has_or_had_comprehensive_overview:
range: Overview
inlined: true
description: |
Comprehensive collection of all links from this finding aid.
Replaces previous all_links slot with typed Overview class.
comments:
- Root class for finding aid metadata YAML files
- Designed for validation with linkml-validate
- Supports Nationaal Archief zoekhulpen structure
- Merged from FindingAidMetadata.yaml (slot names) and FindingAid.yaml (bibliographic slots)
see_also:
- https://www.ica.org/standards/RiC/ontology#FindingAid
- https://www.nationaalarchief.nl/onderzoeken/zoekhulpen
- http://www.cidoc-crm.org/html/cidoc_crm_v7.1.3.html#E31
- http://id.loc.gov/ontologies/bibframe/
MultilingualText:
class_uri: skos:Concept
description: 'Container for multilingual text values (titles, descriptions).
Supports any ISO 639-1 language code as a slot name.
Common slots: nl (Dutch), en (English), de (German), fr (French).
'
slots:
- de
- en
- fr
- nl
- specificity_annotation
- template_specificity
comments:
- At least one language slot should be populated
- nl is primary for Dutch archives
CustodianReference:
class_uri: rico:Agent
description: 'Reference to the heritage custodian that created/maintains this finding aid.
Uses standard identifiers: GHCID, ISIL, Wikidata ID.
'
slots:
- ghcid
- isil
- name
- specificity_annotation
- template_specificity
- wikidata
slot_usage:
ghcid:
required: true
pattern: ^[A-Z]{2}-[A-Z]{2}-[A-Z]{3}-[A-Z]-[A-Z0-9]+$
isil:
pattern: ^[A-Z]{2}-[A-Za-z0-9]+$
name:
required: true
wikidata:
pattern: ^Q[0-9]+$
exact_mappings:
- rico:Agent
- schema:Organization
TemporalCoverage:
class_uri: dcterms:PeriodOfTime
description: 'Time period covered by the finding aid''s materials.
Supports both numeric years and special values like "present".
Can include named periods (key_periods) and significant dates (key_dates).
'
slots:
- end
- has_or_had_key_date
- has_or_had_key_period
- note
- has_or_had_period
- specificity_annotation
- start
- template_specificity
slot_usage:
start:
range: TemporalValue
required: true
end:
range: TemporalValue
required: true
has_or_had_period:
range: TemporalPeriod
multivalued: true
inlined_as_list: true
has_or_had_key_period:
range: TemporalPeriod
multivalued: true
inlined_as_list: true
has_or_had_key_date:
range: KeyDate
multivalued: true
inlined_as_list: true
exact_mappings:
- dcterms:PeriodOfTime
- schema:temporalCoverage
TemporalPeriod:
class_uri: dcterms:PeriodOfTime
description: A named historical period with optional start/end dates and description.
slots:
- period
- period_description
- period_end
- period_name
- period_start
- specificity_annotation
- template_specificity
slot_usage:
period_name:
range: string
required: true
aliases:
- name
period:
range: string
period_start:
range: TemporalValue
aliases:
- start
period_end:
range: TemporalValue
aliases:
- end
period_description:
range: string
aliases:
- description
KeyDate:
class_uri: schema:Event
description: 'A significant historical date with event description.
Used for key_dates within TemporalCoverage.
'
attributes:
date_value:
description: ISO 8601 date (YYYY-MM-DD or YYYY)
range: string
required: true
aliases:
- date
event:
description: Description of what happened (Dutch or original)
range: string
required: true
event_en:
description: English translation of event description
range: string
slots:
- specificity_annotation
- template_specificity
GeographicCoverage:
class_uri: dcterms:Location
description: 'Geographic area covered by the finding aid''s materials.
Supports primary areas, secondary/related areas, and migration patterns.
'
slots:
- colonial
- historical_region
- inbound_from
- international
- major_city
- outbound_to
- primary
- related
- scope
- secondary
- specificity_annotation
- template_specificity
slot_usage:
primary:
multivalued: true
secondary:
multivalued: true
related:
multivalued: true
historical_region:
multivalued: true
colonial:
multivalued: true
international:
multivalued: true
major_city:
multivalued: true
inbound_from:
multivalued: true
outbound_to:
multivalued: true
exact_mappings:
- dcterms:spatial
- schema:spatialCoverage
SubGuideReference:
class_uri: rico:FindingAid
description: 'Reference to a sub-guide or related finding aid within the same repository.
Sub-guides are more specific finding aids linked from a repository guide.
For example, a "Family History" repository guide links to specific sub-guides
for "Civil Registry", "Notarial Records", etc.
'
slots:
- is_or_was_access_restricted
- note
- slug
- specificity_annotation
- sub_guide_description
- sub_guide_temporal_coverage
- has_or_had_type
- template_specificity
# REMOVED: title_en, title_nl - migrated to has_or_had_label with Label (2026-01-14, Rule 53)
- has_or_had_label
- url
slot_usage:
slug:
required: true
has_or_had_label:
range: Label
required: true
multivalued: true
inlined: true
description: |
Multilingual titles for this sub-guide.
MIGRATED from title_nl/title_en slots (2026-01-14) per Rule 53.
Uses Label class with language_code to support any language.
examples:
- value: |
label_value: "Burgerlijke Stand"
language_code: "nl"
description: Dutch title
- value: |
label_value: "Civil Registry"
language_code: "en"
description: English title
url:
required: true
has_or_had_type:
range: SubGuideType
description: |
The type classification of this sub-guide.
Uses SubGuideType class hierarchy.
is_or_was_access_restricted:
range: boolean
exact_mappings:
- rico:isOrWasPartOf
ArchiveReference:
class_uri: rico:RecordSet
description: 'Reference to an archive collection or institution.
Used for key_archives (main archives for a topic) and related_archives
(external archives with related holdings).
'
slots:
- has_or_had_access_condition
- full_name
- isil
- location
- name
- resource_description
- specificity_annotation
- sub_guide_temporal_coverage
- template_specificity
- url
slot_usage:
name:
required: true
url:
range: uri
required: false
isil:
pattern: ^[A-Z]{2}-[A-Za-z0-9]+$
exact_mappings:
- rico:RecordSet
- schema:ArchiveOrganization
RelatedGuideReference:
class_uri: rico:FindingAid
description: 'Reference to a related finding aid guide within the same repository.
Different from sub_guides: these are peer-level guides on related topics,
not hierarchically nested guides.
'
slots:
- relationship
- slug
- specificity_annotation
- template_specificity
# REMOVED: title_en, title_nl - migrated to has_or_had_label with Label (2026-01-14, Rule 53)
- has_or_had_label
slot_usage:
slug:
required: true
has_or_had_label:
range: Label
required: true
multivalued: true
inlined: true
description: |
Multilingual titles for this related guide.
MIGRATED from title_nl/title_en slots (2026-01-14) per Rule 53.
Uses Label class with language_code to support any language.
relationship:
range: RelationshipTypeEnum
AccessRestriction:
class_uri: dcterms:RightsStatement
description: 'Access restriction information for materials.
'
slots:
- permission_required
- restriction_description
- restriction_type
- specificity_annotation
- template_specificity
- has_or_had_restriction
slot_usage:
restriction_type:
required: true
has_or_had_restriction:
range: Restriction
description: |
Structured restriction with temporal extent.
Replaces years_restricted (integer) with Restriction class.
permission_required:
range: boolean
ExternalResource:
class_uri: foaf:Document
description: 'Reference to an external resource (database, organization, portal).
Used to link finding aids to related external resources that complement
the archive''s holdings (e.g., genealogical databases, historical societies).
'
slots:
- name
- resource_description
- specificity_annotation
- template_specificity
- type
- url
slot_usage:
name:
required: true
url:
range: uri
required: true
type:
range: ExternalResourceTypeEnum
exact_mappings:
- foaf:Document
- schema:WebPage
FindingAidProvenance:
class_uri: prov:Activity
description: 'Provenance metadata for web-harvested finding aid information.
Tracks when and how the metadata was retrieved, enabling data freshness
assessment and re-crawling decisions.
'
slots:
- claims_count
- crawler_version
- date_retrieved
- extraction_method
- extraction_note
- html_snapshot_path
- note
- retrieval_agent
- source_url
- specificity_annotation
- template_specificity
# REMOVED 2026-01-14: validation_status - migrated to has_or_had_status with ValidationStatus
- has_or_had_status
slot_usage:
date_retrieved:
range: date
required: true
retrieval_agent:
required: true
source_url:
range: uri
claims_count:
range: integer
has_or_had_status:
range: ValidationStatus
required: false
inlined: true
description: |
Validation status of this finding aid retrieval.
MIGRATED 2026-01-14: Replaces validation_status slot.
examples:
- value:
status_type: VALIDATED
status_date: "2026-01-14"
description: Validated finding aid data
exact_mappings:
- prov:Activity
PageSection:
class_uri: schema:WebPageElement
description: 'A section of a finding aid page with heading and content.
Captures the hierarchical structure of web pages for preservation
and semantic understanding.
'
slots:
- content_block
- has_or_had_featured_item
- heading_level
- heading_text
- heading_text_en
- list_item
- section_id
- has_or_had_section_link
- specificity_annotation
- has_or_had_sub_section
- template_specificity
- xpath
slot_usage:
heading_level:
range: integer
minimum_value: 1
maximum_value: 6
heading_text:
required: true
content_block:
multivalued: true
has_or_had_sub_section:
range: PageSection
multivalued: true
inlined_as_list: true
has_or_had_section_link:
range: PageLink
multivalued: true
inlined_as_list: true
has_or_had_featured_item:
range: FeaturedCard
multivalued: true
inlined_as_list: true
list_item:
multivalued: true
exact_mappings:
- schema:WebPageElement
PageLink:
class_uri: schema:WebPage
description: 'A hyperlink extracted from a page.
'
slots:
- is_sub_guide
- link_context
- link_text
- link_type
- link_url
- specificity_annotation
- template_specificity
- xpath
slot_usage:
link_text:
required: true
link_url:
range: uri
required: true
link_type:
range: LinkTypeEnum
is_sub_guide:
range: boolean
FeaturedCard:
class_uri: schema:CreativeWork
description: 'A featured content card (often with image/icon).
Common on archive websites to highlight important sub-guides or resources.
'
slots:
- card_description
- card_description_en
- card_image_url
- card_title
- card_title_en
- card_url
- specificity_annotation
- template_specificity
- xpath
slot_usage:
card_title:
required: true
card_url:
range: uri
card_image_url:
range: uri
types:
TemporalValue:
typeof: string
uri: xsd:string
description: 'A temporal value that can be either a year (integer) or special value like "present".
Examples: 1572, 1811, "present", "ongoing"
'