glam/schemas/20251121/linkml/modules/classes/AvailabilityStatus.yaml

81 lines
2.9 KiB
YAML

id: https://nde.nl/ontology/hc/class/AvailabilityStatus
name: availability_status_class
title: AvailabilityStatus Class
imports:
- linkml:types
- ../slots/has_or_had_description
- ../slots/has_or_had_label
- ../slots/temporal_extent
prefixes:
linkml: https://w3id.org/linkml/
hc: https://nde.nl/ontology/hc/
schema: http://schema.org/
dcat: http://www.w3.org/ns/dcat#
dcterms: http://purl.org/dc/terms/
default_prefix: hc
classes:
AvailabilityStatus:
class_uri: schema:Availability
description: 'Represents the availability state of a resource, service, or feature.
**DEFINITION**:
AvailabilityStatus models whether something (API, service, feature, resource) is currently available for use. This replaces domain-specific boolean flags like `api_available` with a structured class that can capture temporal validity and descriptive context.
**ONTOLOGY ALIGNMENT**:
- Schema.org: `schema:Availability` - availability of a product/service - DCAT: `dcat:DataService` availability patterns - DCTERMS: `dcterms:available` - date resource became available
**USE CASES**:
1. **API Availability**: Whether a CMS provides API access 2. **Service Availability**: Whether a digital platform is operational 3. **Feature Availability**: Whether specific features are enabled
**TEMPORAL VALIDITY**:
Availability can change over time: - API available from 2015-01-01 to 2020-12-31 (deprecated) - Service temporarily unavailable during maintenance'
exact_mappings:
- schema:Availability
close_mappings:
- dcat:DataService
related_mappings:
- dcterms:available
slots:
- has_or_had_label
- has_or_had_description
- temporal_extent
slot_usage:
has_or_had_label:
# range: string
required: false
examples:
- value: API Available
- value: Service Unavailable
has_or_had_description:
# range: string
examples:
- value: REST API available with JSON responses
temporal_extent:
range: TimeSpan
inlined: true
required: false
examples:
- value:
begin_of_the_begin: '2015-01-01'
- value:
begin_of_the_begin: '2015-06-01'
end_of_the_end: '2020-12-31'
comments:
- Generic availability status class replacing domain-specific boolean flags
- Supports temporal validity for tracking when availability changed
- Aligns with Schema.org Availability enumeration pattern
see_also:
- https://schema.org/Availability
- https://www.w3.org/TR/vocab-dcat-2/#Class:DataService
examples:
- value:
has_or_had_label: API Available
has_or_had_description: REST API with JSON responses available for collection metadata access
annotations:
specificity_score: 0.1
specificity_rationale: Generic utility class/slot created during migration
custodian_types: "['*']"