Skip to content

Commit

Permalink
Alignment with onboarding document.
Browse files Browse the repository at this point in the history
  • Loading branch information
henrietteharmse committed Nov 10, 2023
1 parent cac8969 commit 74df189
Show file tree
Hide file tree
Showing 11 changed files with 888 additions and 428 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The core model is designed to represent data about a rare disease patient and bi
The figure below gives an overview of upper level concepts and properties used in our metadata model.

<p align="center">
<img src="docs/ResourceMetadataSchema.png">
<img src="images/diagram_onboarding_doc/.png">
</p>

You can browse different metadata modules by visiting the links below.
Expand Down
191 changes: 126 additions & 65 deletions template/Biobank.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,110 +2,171 @@
Defines all the biobanks for this EJP RD resource in the case where datasets are about content
of a rare disease resources such as biobanks.

## Title
The name of the biobank. This is a required field and needs to be unique in this spreadsheet.
## License
This should contain a URL that provides details regarding the license that is applicable to this resource.
If no suitable license can be provided, then the default license should be used:
[https://w3id.org/ejp-rd/resources/licenses/v1.0/](https://w3id.org/ejp-rd/resources/licenses/v1.0/). Other licenses are:
[https://creativecommons.org/licenses/](https://creativecommons.org/licenses/),
e.g. [http://creativecommons.org/licenses/by-nc-nd/4.0](http://creativecommons.org/licenses/by-nc-nd/4.0).

*Used by:*
[Catalog](Catalog.md)
> **Warning** This field is `required`, and should be `unique`
> **Warning** This field is `required`
## Logo
A graphic representation of this resource.
> **Note** This field is `optional`
## Title
The name of the Biobank. This is a required field and needs to be unique.

> **Warning** This field is `required`, and should be `unique`.
## Description
A description of this biobank.
> **Warning** This field is `required`
A description of this Biobank

## PopulationCoverage
Gives an indication of the part of the population covered by this biobank. This field must have 1 of
the following values: "National", "International", "Regional" or "European".
> **Warning** This field is `required`

## Theme
It consists of 1 or more IRIs separated by commas. When set, it specifies relevant ontology concepts
that classify the biobank. Typically these can be looked up using the [Ontology Lookup Service](https://www.ebi.ac.uk/ols/index) (OLS).
Points to an URL that specifies relevant ontology concepts that classify the Biobank. Typically, these can be looked
up using the [Ontology Lookup Service (OLS)](https://www.ebi.ac.uk/ols4/index) or [Bioportal](https://bioportal.bioontology.org/).

> **Warning** This field is `required`
## Publisher
The title of an organisation that has been specified on the [Organisation](Organisation.md) sheet.
Pointer to the Organisation that published
the resource. The range is
foaf:Organisation.

> **Warning** This field is `required`
## License
This should contain a URL that provides details regarding the license that is applicable to this resource.
If no suitable license can be provided, then the default license should be used:
https://w3id.org/ejp-rd/resources/licenses/v1.0/.

## Contact Point
Pointer to a Contact Point, Range, vCard

> **Warning** This field is `required`
## Personal Data
Set to "true" if the resource onboarded to
the Virtual Platform contains personal
data, personal data meaning data
related to identified or identifiable
persons (as per GDPR definition),
otherwise "false". The range is string.

> **Warning** This field is `required`
## PersonalData
Set to "true" if the resource onboarded to the Virtual Platform contains personal data, personal data
meaning data related to indentified or identifiable persons (as per GDPR definition), otherwise "false".
> **Warning** This field is `required`.
## Population Coverage
Gives an indication of the part of the
population covered by this patient
registry. This field must have 1 of the
following values: "National",
"International", "Regional" or "European".
The range is string.

## ConformsTo
If applicable, it should point to the IRI an established standard to which the described resource conforms
> **Recommendation** Specifying a value for this field is `recommended`
> **Warning** This field is `required`
## Type
Defines the type of this resource which for the EJP RD Virtual Platform can be one of the following:
## Language
An ISO 639-1 two-letter code for the
languages this patient registry is provided
in. Example: en indicates that this patient
registry is available in English. The range is
an xsd:string. The ISO language codes
can be found at:
[https://id.loc.gov/vocabulary/iso639-1.html](https://id.loc.gov/vocabulary/iso639-1.html) and an example:
[en](http://id.loc.gov/vocabulary/iso639-1/en).

- http://purl.org/ejp-rd/vocabulary/VPBeacon2_individuals: the annotated resource (always a DataService) provides the Beacon2 /individuals interface
- http://purl.org/ejp-rd/vocabulary/VPBeacon2_catalog: the annotated resource (always a DataService) provides the Beacon2 /catalog interface
> **Warning** This field is `required`

## Webpages
This is a commas separated list of the URLs to webpages with more information regarding the organisation. Each URL has to
start with http:// or https://.
> **Note** This field is `optional`
## Access Rights
Information about who can access the
resource or an indication of its security status.
This should point to a URL where this
information can be found. We strongly
recommend that access rights are described
as [DUC CCE profile](https://duc.le.ac.uk/).

> **Recommendation** This field is `recommended`

## Landing Page
This a URL to a web page with more
information regarding the Biobank. Any URL
must start with http:// or https://.

> **Recommendation** This field is `recommended`

## Keywords
The list of keywords applicable to this biobank, separated by commas.
## Distribution
Use this property to point to the
distribution of this dataset when a
distribution is available. Range is
dcat:Distribution.

> **Note** This field is `optional`
## Language
A comma separated list of ISO 639-1 two-letter codes for the languages this biobank is provided in.
## VPConnection
This property is attached to every
portion of your Metadata record
that you wish the VP to explore
(e.g. Dataset X, Data Service Y, but
NOT Dataset Z). If you do not add
this tag to at least the description of
your resource, you will not be
onboarded.
The range is [http://purl.org/ejp-rd/vocabulary/VPDiscoverable](http://purl.org/ejp-rd/vocabulary/VPDiscoverable).

*Example:*
en,nl indicates that this biobank is available in English and Dutch/Flemish.
> **Note** This field is `optional`
> **Warning** This field is `required`
## ODRL Policy
An ODRL conformant policy
document (https://www.w3.org/TR/
odrl-model/) expressing the rights
and/or responsibilities associated
with access to and/or use of the
resource. This should point to a URL
where this conformant document
has been published.

## AccessRight
Information about who can access the resource or an indication of its security status. This should
point to a URL where this information can be found.
> **Note** This field is `optional`
> **Recommendation** Specifying a value for this field is `recommended`
## Keyword
Keywords applicable to this
Biobank

## ODRLPolicy (in DCAT 2 `odrl:hasPolicy`)
An ODRL conformant policy expressing the rights associated with the resource. This should point to
a URL where this information can be found.
> **Note** This field is `optional`
> **Recommendation** Specifying a value for this field is `recommended`
## Logo
A link to the graphic representation
of this resource.

> **Note** This field is `optional`
## Identifier
A unique identifier of the item. Recommended practice is to identify the resource by means of a string
conforming to an identification system. Examples include International Standard Book Number (ISBN),
Digital Object Identifier (DOI), and Uniform Resource Name (URN). Persistent identifiers should be
provided as HTTP URIs.
> **Warning** This field is `required`
Identifier of this resource. It can be
a link. Range is an xsd:string

## ContactPoint
Relevant [contact information](ContactPoint.md) for this biobank.
> **Warning** This field is `required`
> **Note** This field is `optional`
## Issued
The date on which this biobank was created
> **Warning** This field is `required`
This resource publication date. The
range is xsd:date.

> **Note** This field is `optional`
## Modified
The date on which this biobank was updated or same as issue date if it has not been modified.
> **Warning** This field is `required`
This resource last revision date. The
range is xsd:date.

> **Note** This field is `optional`
## Version
If applicable, it should provide the version of the biobank as a string of text.
> **Note** This field is `optional`
The version indicator (name or
identifier) of a resource. The range
is a rdfs:literal

> **Note** This field is `optional`
## Conforms To
If applicable, it should point to the
URL, an established standard to
which the data within the
described resource conforms (e.g.
MAGE-ML for Microarray data).

> **Note** This field is `optional`
Loading

0 comments on commit 74df189

Please sign in to comment.