id: https://w3id.org/hc/classes/identifier-format
name: IdentifierFormat

prefixes:
  linkml: https://w3id.org/linkml/
  schema: http://schema.org/
  hc: https://nde.nl/ontology/hc/

imports:
  - linkml:types

default_prefix: hc
default_range: string

classes:
  IdentifierFormat:
    class_uri: schema:PropertyValue
    description: A specific format variant for an identifier standard.
    
    attributes:
      id:
        identifier: true
        range: uriorcurie
        required: true
      
      format_name:
        slot_uri: schema:name
        description: The name of this identifier format variant (e.g., 'ISIL with prefix', 'bare ISIL').
        range: string
        required: true
      
      pattern:
        slot_uri: schema:pattern
        description: Regular expression pattern for validating identifiers in this format.
        range: string
        required: true
      
      example:
        slot_uri: schema:exampleOfWork
        description: An example identifier string demonstrating this format.
        range: string
        required: true
      
      is_canonical:
        slot_uri: schema:isBasedOn
        description: Whether this format is the canonical (preferred) representation for this identifier standard.
        range: boolean
        required: true
      
      is_uri_format:
        slot_uri: schema:url
        description: Whether this format produces valid URIs/IRIs that can be used as linked data identifiers.
        range: boolean
        required: true
      
      transformation_to_canonical:
        slot_uri: schema:algorithm
        description: Algorithm or transformation rule to convert this format to the canonical format (if not canonical).
        range: string