Class: Vocabulary

name: Vocabulary
description: Flat table containing each of the ontologies used for dataset annotations
from_schema: https://includedcc.org/common-access-model
slots:
- vocabulary_prefix
- name
- vocabulary_uri
- vocabulary_id
- fhir_system
- description
- version
- vocabulary_source
slot_usage:
  vocabulary_prefix:
    name: vocabulary_prefix
    todos:
    - Ensure that MapDragon and TermWeaver both rely on the same rules for prefixes
    comments:
    - Must start with a letter; thereafter allows letters, digits, underscores, hyphens,
      and dots to accommodate OLS/UMLS source variability.
    - 'RISK: In order for all of our data to correctly join, the format of the prefix
      must always align with the prefix used in this table.'
    identifier: true
    range: string
    pattern: ^[A-Za-z][A-Za-z0-9_\-\.]*$

name: Vocabulary
description: Flat table containing each of the ontologies used for dataset annotations
from_schema: https://includedcc.org/common-access-model
slot_usage:
  vocabulary_prefix:
    name: vocabulary_prefix
    todos:
    - Ensure that MapDragon and TermWeaver both rely on the same rules for prefixes
    comments:
    - Must start with a letter; thereafter allows letters, digits, underscores, hyphens,
      and dots to accommodate OLS/UMLS source variability.
    - 'RISK: In order for all of our data to correctly join, the format of the prefix
      must always align with the prefix used in this table.'
    identifier: true
    range: string
    pattern: ^[A-Za-z][A-Za-z0-9_\-\.]*$
attributes:
  vocabulary_prefix:
    name: vocabulary_prefix
    description: The authoritative namespace prefix allocated to the vocabulary. Used
      to resolve compact identifiers (CURIEs) to their full semantic URIs or FHIR
      system URLs.
    title: Canonical Curie Prefix
    todos:
    - Ensure that MapDragon and TermWeaver both rely on the same rules for prefixes
    comments:
    - Must start with a letter; thereafter allows letters, digits, underscores, hyphens,
      and dots to accommodate OLS/UMLS source variability.
    - 'RISK: In order for all of our data to correctly join, the format of the prefix
      must always align with the prefix used in this table.'
    from_schema: https://includedcc.org/common-access-model
    rank: 1000
    identifier: true
    owner: Vocabulary
    domain_of:
    - Concept
    - Vocabulary
    range: string
    required: true
    pattern: ^[A-Za-z][A-Za-z0-9_\-\.]*$
  name:
    name: name
    description: Name of the entity.
    title: Name
    from_schema: https://includedcc.org/common-access-model
    rank: 1000
    owner: Vocabulary
    domain_of:
    - VirtualBiorepository
    - Investigator
    - Vocabulary
    - EncounterDefinition
    - ActivityDefinition
    - Dataset
    range: string
    required: false
  vocabulary_uri:
    name: vocabulary_uri
    description: Official URI associated with the vocabulary
    title: Vocabulary URI
    from_schema: https://includedcc.org/common-access-model
    rank: 1000
    owner: Vocabulary
    domain_of:
    - Vocabulary
    range: uri
    required: true
  vocabulary_id:
    name: vocabulary_id
    description: The OMOP Vocabulary ID associated with the vocabulary, if applicable
    title: OMOP Vocabulary ID
    from_schema: https://includedcc.org/common-access-model
    rank: 1000
    owner: Vocabulary
    domain_of:
    - Vocabulary
    range: string
  fhir_system:
    name: fhir_system
    description: System used within FHIR valuesets and codings
    title: FHIR System
    from_schema: https://includedcc.org/common-access-model
    rank: 1000
    owner: Vocabulary
    domain_of:
    - Vocabulary
    range: uri
    required: true
  description:
    name: description
    description: Description for this entity.
    title: Description
    from_schema: https://includedcc.org/common-access-model
    rank: 1000
    owner: Vocabulary
    domain_of:
    - Vocabulary
    - EncounterDefinition
    - ActivityDefinition
    - Dataset
    range: string
  version:
    name: version
    description: Version associated with the current vocabulary content
    title: Version
    from_schema: https://includedcc.org/common-access-model
    rank: 1000
    owner: Vocabulary
    domain_of:
    - Vocabulary
    range: string
  vocabulary_source:
    name: vocabulary_source
    description: Source used for accessing the vocabulary's content
    title: Vocabulary data source
    comments:
    - This is currently poorly defined because we haven't fully defined the nature
      of the data pulls. Most likely it will end up as a filename (.owl, .obo, etc)
      or another tool, etc
    from_schema: https://includedcc.org/common-access-model
    rank: 1000
    owner: Vocabulary
    domain_of:
    - Vocabulary
    range: string