GitHub Twitter

Beacon DRAFT Profile

Version: 0.2-draft (23 April 2018)

A convention for beacon to self-describe.


Contributors

The following people have been involved in the creation of this specification document. They are all members of the Beacons group.

Group Leader(s)

Serena Scollen

Audald Lloret

Other team members

Schema.org hierarchy

This Profile fits into the schema.org hierarchy as follows:

Thing > CreativeWork > DataCatalog

Description

In this document we propose a simple way for a beacons to self-describe their genetic variant cardinality service for better integration with other beacons within the beacon-network. It builds upon the Beacon service API and uses existing schema.org entities and properties.





Key to specification table

Schema.org properties where the Expected Types have been changed, or new (i.e., Bioschemas created) properties/types are green.

Schema.org properties/types are red.

Pending Schema.org properties/types are blue.

External (i.e., from 3rd party ontology) properties/types are black.


CD = Cardinality


Property Expected Type Description CD Controlled Vocabulary Example
Marginality: Minimum.
dataset DataCatalog
Schema:

A dataset contained in this catalog. inverse property: includedInDataCatalog.


Bioschemas:

Datasets served by this Beacon.

MANY
name Text
Schema:

The name of the item.


Bioschemas:

Name of this Beacon.

ONE
potentialAction Action
Schema:

Indicates a potential Action, which describes an idealized action in which this thing would play an ‘object’ role.


Bioschemas:

List of Actions that can be performed on this Beacon.

MANY
provider Organization
Person
Schema:

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes carrier.


Bioschemas:

Contact information for this Beacon.

MANY
rdf:type URL
Bioschemas:

This is used by validation tools to indentify the profile used. You must use the value specified in the Controlled Vocabulary column.

ONE
supportedRefs Text
Bioschemas:

Supported Genome ID references.

MANY
url URL
Schema:

URL of the item.


Bioschemas:

Welcome Page of this Beacon.

ONE
Marginality: Recommended.
aggregator Boolean
Bioschemas:

True if Beacon is an agregator of other Beacon Datasets.

ONE
description Text
Schema:

A description of the item.


Bioschemas:

Description of this Beacon.

ONE
identifier PropertyValue
Text
URL
Schema:

The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details.


Bioschemas:

Unique identifier of the Beacon.

ONE
version Number
Text
Schema:

The version of the CreativeWork embodied by a specified resource.


Bioschemas:

Beacon API version number.

ONE
Marginality: Optional.
sameAs URL
Schema:

URL of a reference Web page that unambiguously indicates the item’s identity. E.g. the URL of the item’s Wikipedia page, Wikidata entry, or official website.


Bioschemas:

Alternative URL for this Beacon.

MANY

Top ▲