Skip to content

Class: ProtocolReference

Reference to a versioned review protocol or guideline that a review or record declares conformance to (e.g., PRISMA 2020, ROBIS, RoB 2).

URI: revaise:ProtocolReference

```mermaid classDiagram class ProtocolReference click ProtocolReference href "../ProtocolReference/" ProtocolReference : applicable_review_types

    ProtocolReference --> "*" ReviewType : applicable_review_types
    click ReviewType href "../ReviewType/"



  ProtocolReference : protocol_citation

  ProtocolReference : protocol_id

  ProtocolReference : protocol_kind





    ProtocolReference --> "1" ProtocolKind : protocol_kind
    click ProtocolKind href "../ProtocolKind/"



  ProtocolReference : protocol_name

  ProtocolReference : protocol_uri

  ProtocolReference : protocol_version

```

Slots

Name Cardinality and Range Description Inheritance
protocol_id 1
String
Unique identifier for this protocol reference within the document direct
protocol_name 1
String
Human-readable name of the protocol or guideline direct
protocol_version 0..1
String
Version of the protocol or guideline direct
protocol_uri 1
Uri
Versioned URI identifying the external protocol specification direct
protocol_kind 1
ProtocolKind
Category of the protocol direct
applicable_review_types *
ReviewType
Review types the protocol applies to direct
protocol_citation 0..1
String
Bibliographic citation for the protocol direct

Usages

used by used in type used
LiteratureRecord conforms_to range ProtocolReference
Review conforms_to range ProtocolReference

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ProtocolReference
description: Reference to a versioned review protocol or guideline that a review or
  record declares conformance to (e.g., PRISMA 2020, ROBIS, RoB 2).
from_schema: https://open-and-sustainable.github.io/revaise-model/schema
slots:
- protocol_id
- protocol_name
- protocol_version
- protocol_uri
- protocol_kind
- applicable_review_types
- protocol_citation
slot_usage:
  protocol_id:
    name: protocol_id
    description: Unique identifier for this protocol reference within the document
    identifier: true
    required: true
  protocol_name:
    name: protocol_name
    description: Human-readable name of the protocol or guideline
    required: true
  protocol_uri:
    name: protocol_uri
    description: Versioned URI identifying the external protocol specification
    required: true
  protocol_kind:
    name: protocol_kind
    description: Category of the protocol
    required: true
  applicable_review_types:
    name: applicable_review_types
    description: Review types the protocol applies to
    multivalued: true

Induced

name: ProtocolReference
description: Reference to a versioned review protocol or guideline that a review or
  record declares conformance to (e.g., PRISMA 2020, ROBIS, RoB 2).
from_schema: https://open-and-sustainable.github.io/revaise-model/schema
slot_usage:
  protocol_id:
    name: protocol_id
    description: Unique identifier for this protocol reference within the document
    identifier: true
    required: true
  protocol_name:
    name: protocol_name
    description: Human-readable name of the protocol or guideline
    required: true
  protocol_uri:
    name: protocol_uri
    description: Versioned URI identifying the external protocol specification
    required: true
  protocol_kind:
    name: protocol_kind
    description: Category of the protocol
    required: true
  applicable_review_types:
    name: applicable_review_types
    description: Review types the protocol applies to
    multivalued: true
attributes:
  protocol_id:
    name: protocol_id
    description: Unique identifier for this protocol reference within the document
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    identifier: true
    owner: ProtocolReference
    domain_of:
    - ProtocolReference
    range: string
    required: true
  protocol_name:
    name: protocol_name
    description: Human-readable name of the protocol or guideline
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ProtocolReference
    domain_of:
    - ProtocolReference
    range: string
    required: true
  protocol_version:
    name: protocol_version
    description: Version of the protocol or guideline
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ProtocolReference
    domain_of:
    - ProtocolReference
    range: string
  protocol_uri:
    name: protocol_uri
    description: Versioned URI identifying the external protocol specification
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ProtocolReference
    domain_of:
    - ProtocolReference
    range: uri
    required: true
  protocol_kind:
    name: protocol_kind
    description: Category of the protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ProtocolReference
    domain_of:
    - ProtocolReference
    range: ProtocolKind
    required: true
  applicable_review_types:
    name: applicable_review_types
    description: Review types the protocol applies to
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ProtocolReference
    domain_of:
    - ProtocolReference
    range: ReviewType
    multivalued: true
  protocol_citation:
    name: protocol_citation
    description: Bibliographic citation for the protocol
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema
    rank: 1000
    owner: ProtocolReference
    domain_of:
    - ProtocolReference
    range: string