Skip to content

Class: ExternalTool

External tool or platform used in the review process

URI: revaise:ExternalTool

```mermaid classDiagram class ExternalTool click ExternalTool href "../ExternalTool/" ExternalTool : tool_ai_models

  ExternalTool : tool_api_endpoint

  ExternalTool : tool_api_version

  ExternalTool : tool_citation

  ExternalTool : tool_configuration_file

  ExternalTool : tool_configuration_parameters





    ExternalTool --> "*" ToolParameter : tool_configuration_parameters
    click ToolParameter href "../ToolParameter/"



  ExternalTool : tool_cost

  ExternalTool : tool_documentation_url

  ExternalTool : tool_export_formats

  ExternalTool : tool_features_used

  ExternalTool : tool_id

  ExternalTool : tool_import_formats

  ExternalTool : tool_license_type





    ExternalTool --> "0..1" ToolLicenseType : tool_license_type
    click ToolLicenseType href "../ToolLicenseType/"



  ExternalTool : tool_limitations

  ExternalTool : tool_name

  ExternalTool : tool_notes

  ExternalTool : tool_purpose





    ExternalTool --> "1..*" ToolPurpose : tool_purpose
    click ToolPurpose href "../ToolPurpose/"



  ExternalTool : tool_settings

  ExternalTool : tool_subscription_level

  ExternalTool : tool_url

  ExternalTool : tool_vendor

  ExternalTool : tool_version

```

Slots

Name Cardinality and Range Description Inheritance
tool_id 1
String
Unique identifier for the tool direct
tool_name 1
String
Name of the tool (e direct
tool_version 1
String
Version of the tool used direct
tool_url 0..1
Uri
URL to access the tool or platform direct
tool_vendor 0..1
String
Vendor or organization providing the tool direct
tool_purpose 1..*
ToolPurpose
Purpose(s) for which the tool was used direct
tool_license_type 0..1
ToolLicenseType
Type of license for the tool direct
tool_subscription_level 0..1
String
Subscription level or plan used (if applicable) direct
tool_configuration_file 0..1
Uri
URI to exported configuration file direct
tool_configuration_parameters *
ToolParameter
Tool-specific configuration parameters direct
tool_settings 0..1
String
General settings description or JSON configuration direct
tool_api_endpoint 0..1
Uri
API endpoint if accessed programmatically direct
tool_api_version 0..1
String
Version of the API used direct
tool_export_formats *
String
Data formats the tool can export direct
tool_import_formats *
String
Data formats the tool can import direct
tool_features_used *
String
Specific features of the tool that were used direct
tool_ai_models *
String
AI models used by the tool (if disclosed) direct
tool_limitations 0..1
String
Known limitations or issues encountered direct
tool_citation 0..1
String
Recommended citation for the tool direct
tool_documentation_url 0..1
Uri
URL to tool documentation direct
tool_cost 0..1
String
Cost information (subscription, per-use, etc direct
tool_notes 0..1
String
Additional notes about tool usage direct

Usages

used by used in type used
StageProtocol base_protocol_tools range ExternalTool
StageProtocol base_protocol_software range ExternalTool
RegistrationProtocol base_protocol_tools range ExternalTool
RegistrationProtocol base_protocol_software range ExternalTool
SearchProtocol base_protocol_tools range ExternalTool
SearchProtocol base_protocol_software range ExternalTool
DeduplicationProcess dedup_tools range ExternalTool
ScreeningRound screening_tools range ExternalTool
ScreeningProtocol base_protocol_tools range ExternalTool
ScreeningProtocol base_protocol_software range ExternalTool
ExtractionProtocol base_protocol_tools range ExternalTool
ExtractionProtocol base_protocol_software range ExternalTool
SynthesisProtocol base_protocol_tools range ExternalTool
SynthesisProtocol base_protocol_software range ExternalTool

Identifier and Mapping Information

Schema Source

  • from schema: https://open-and-sustainable.github.io/revaise-model/schema

Mappings

Mapping Type Mapped Value
self revaise:ExternalTool
native revaise:ExternalTool

LinkML Source

Direct

name: ExternalTool
description: External tool or platform used in the review process
from_schema: https://open-and-sustainable.github.io/revaise-model/schema
slots:
- tool_id
- tool_name
- tool_version
- tool_url
- tool_vendor
- tool_purpose
- tool_license_type
- tool_subscription_level
- tool_configuration_file
- tool_configuration_parameters
- tool_settings
- tool_api_endpoint
- tool_api_version
- tool_export_formats
- tool_import_formats
- tool_features_used
- tool_ai_models
- tool_limitations
- tool_citation
- tool_documentation_url
- tool_cost
- tool_notes
slot_usage:
  tool_id:
    name: tool_id
    description: Unique identifier for the tool
    identifier: true
    range: string
  tool_name:
    name: tool_name
    description: Name of the tool (e.g., Covidence, RevMan, Elicit, PrismaAI)
    range: string
    required: true
  tool_version:
    name: tool_version
    description: Version of the tool used
    range: string
    required: true
  tool_url:
    name: tool_url
    description: URL to access the tool or platform
    range: uri
  tool_vendor:
    name: tool_vendor
    description: Vendor or organization providing the tool
    range: string
  tool_purpose:
    name: tool_purpose
    description: Purpose(s) for which the tool was used
    range: ToolPurpose
    required: true
    multivalued: true
  tool_license_type:
    name: tool_license_type
    description: Type of license for the tool
    range: ToolLicenseType
  tool_subscription_level:
    name: tool_subscription_level
    description: Subscription level or plan used (if applicable)
    range: string
  tool_configuration_file:
    name: tool_configuration_file
    description: URI to exported configuration file
    range: uri
  tool_configuration_parameters:
    name: tool_configuration_parameters
    description: Tool-specific configuration parameters
    range: ToolParameter
    multivalued: true
  tool_settings:
    name: tool_settings
    description: General settings description or JSON configuration
    range: string
  tool_api_endpoint:
    name: tool_api_endpoint
    description: API endpoint if accessed programmatically
    range: uri
  tool_api_version:
    name: tool_api_version
    description: Version of the API used
    range: string
  tool_export_formats:
    name: tool_export_formats
    description: Data formats the tool can export
    range: string
    multivalued: true
  tool_import_formats:
    name: tool_import_formats
    description: Data formats the tool can import
    range: string
    multivalued: true
  tool_features_used:
    name: tool_features_used
    description: Specific features of the tool that were used
    range: string
    multivalued: true
  tool_ai_models:
    name: tool_ai_models
    description: AI models used by the tool (if disclosed)
    range: string
    multivalued: true
  tool_limitations:
    name: tool_limitations
    description: Known limitations or issues encountered
    range: string
  tool_citation:
    name: tool_citation
    description: Recommended citation for the tool
    range: string
  tool_documentation_url:
    name: tool_documentation_url
    description: URL to tool documentation
    range: uri
  tool_cost:
    name: tool_cost
    description: Cost information (subscription, per-use, etc.)
    range: string
  tool_notes:
    name: tool_notes
    description: Additional notes about tool usage
    range: string

Induced

name: ExternalTool
description: External tool or platform used in the review process
from_schema: https://open-and-sustainable.github.io/revaise-model/schema
slot_usage:
  tool_id:
    name: tool_id
    description: Unique identifier for the tool
    identifier: true
    range: string
  tool_name:
    name: tool_name
    description: Name of the tool (e.g., Covidence, RevMan, Elicit, PrismaAI)
    range: string
    required: true
  tool_version:
    name: tool_version
    description: Version of the tool used
    range: string
    required: true
  tool_url:
    name: tool_url
    description: URL to access the tool or platform
    range: uri
  tool_vendor:
    name: tool_vendor
    description: Vendor or organization providing the tool
    range: string
  tool_purpose:
    name: tool_purpose
    description: Purpose(s) for which the tool was used
    range: ToolPurpose
    required: true
    multivalued: true
  tool_license_type:
    name: tool_license_type
    description: Type of license for the tool
    range: ToolLicenseType
  tool_subscription_level:
    name: tool_subscription_level
    description: Subscription level or plan used (if applicable)
    range: string
  tool_configuration_file:
    name: tool_configuration_file
    description: URI to exported configuration file
    range: uri
  tool_configuration_parameters:
    name: tool_configuration_parameters
    description: Tool-specific configuration parameters
    range: ToolParameter
    multivalued: true
  tool_settings:
    name: tool_settings
    description: General settings description or JSON configuration
    range: string
  tool_api_endpoint:
    name: tool_api_endpoint
    description: API endpoint if accessed programmatically
    range: uri
  tool_api_version:
    name: tool_api_version
    description: Version of the API used
    range: string
  tool_export_formats:
    name: tool_export_formats
    description: Data formats the tool can export
    range: string
    multivalued: true
  tool_import_formats:
    name: tool_import_formats
    description: Data formats the tool can import
    range: string
    multivalued: true
  tool_features_used:
    name: tool_features_used
    description: Specific features of the tool that were used
    range: string
    multivalued: true
  tool_ai_models:
    name: tool_ai_models
    description: AI models used by the tool (if disclosed)
    range: string
    multivalued: true
  tool_limitations:
    name: tool_limitations
    description: Known limitations or issues encountered
    range: string
  tool_citation:
    name: tool_citation
    description: Recommended citation for the tool
    range: string
  tool_documentation_url:
    name: tool_documentation_url
    description: URL to tool documentation
    range: uri
  tool_cost:
    name: tool_cost
    description: Cost information (subscription, per-use, etc.)
    range: string
  tool_notes:
    name: tool_notes
    description: Additional notes about tool usage
    range: string
attributes:
  tool_id:
    name: tool_id
    description: Unique identifier for the tool
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    identifier: true
    alias: tool_id
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
  tool_name:
    name: tool_name
    description: Name of the tool (e.g., Covidence, RevMan, Elicit, PrismaAI)
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_name
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
    required: true
  tool_version:
    name: tool_version
    description: Version of the tool used
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_version
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
    required: true
  tool_url:
    name: tool_url
    description: URL to access the tool or platform
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_url
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: uri
  tool_vendor:
    name: tool_vendor
    description: Vendor or organization providing the tool
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_vendor
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
  tool_purpose:
    name: tool_purpose
    description: Purpose(s) for which the tool was used
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_purpose
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: ToolPurpose
    required: true
    multivalued: true
  tool_license_type:
    name: tool_license_type
    description: Type of license for the tool
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_license_type
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: ToolLicenseType
  tool_subscription_level:
    name: tool_subscription_level
    description: Subscription level or plan used (if applicable)
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_subscription_level
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
  tool_configuration_file:
    name: tool_configuration_file
    description: URI to exported configuration file
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_configuration_file
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: uri
  tool_configuration_parameters:
    name: tool_configuration_parameters
    description: Tool-specific configuration parameters
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_configuration_parameters
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: ToolParameter
    multivalued: true
  tool_settings:
    name: tool_settings
    description: General settings description or JSON configuration
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_settings
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
  tool_api_endpoint:
    name: tool_api_endpoint
    description: API endpoint if accessed programmatically
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_api_endpoint
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: uri
  tool_api_version:
    name: tool_api_version
    description: Version of the API used
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_api_version
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
  tool_export_formats:
    name: tool_export_formats
    description: Data formats the tool can export
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_export_formats
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
    multivalued: true
  tool_import_formats:
    name: tool_import_formats
    description: Data formats the tool can import
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_import_formats
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
    multivalued: true
  tool_features_used:
    name: tool_features_used
    description: Specific features of the tool that were used
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_features_used
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
    multivalued: true
  tool_ai_models:
    name: tool_ai_models
    description: AI models used by the tool (if disclosed)
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_ai_models
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
    multivalued: true
  tool_limitations:
    name: tool_limitations
    description: Known limitations or issues encountered
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_limitations
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
  tool_citation:
    name: tool_citation
    description: Recommended citation for the tool
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_citation
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
  tool_documentation_url:
    name: tool_documentation_url
    description: URL to tool documentation
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_documentation_url
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: uri
  tool_cost:
    name: tool_cost
    description: Cost information (subscription, per-use, etc.)
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_cost
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string
  tool_notes:
    name: tool_notes
    description: Additional notes about tool usage
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    alias: tool_notes
    owner: ExternalTool
    domain_of:
    - ExternalTool
    range: string