Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/chapter/4-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Properties derived from draft [HealthDCAT-AP](https://healthdataeu.pages.code.eu
A tabular overview of all classes and properties—including their range, cardinality, controlled vocabulary (if applicable), and usage notes—is provided below. A reference sheet containing this information can be found [here](Documents/Metadata_CoreGenericHealth_v2.xlsx). This sheet also documents property histories (compared to v1 of the Health-RI core metadata schema) and specifies the origins of new constraints (whether they stem from DCAT-AP v3, DCAT-AP NL, or HealthDCAT-AP).


## UML Class Diagram v2.0.2
## UML Class Diagram v2.0.3

<a href="https://raw.githubusercontent.com/Health-RI/metadata-documentation/main/src/images/HRI_metadata_p2.png" target="_blank">
<img src="https://raw.githubusercontent.com/Health-RI/metadata-documentation/main/src/images/HRI_metadata_p2.png" alt="Health-RI Metadata Diagram" width=800 height=1100 title="diagram">
Expand Down
Binary file modified src/excel/HealthRI_v2.0.2.xlsx
Binary file not shown.
Binary file added src/excel/HealthRI_v2.0.3.xlsx
Binary file not shown.
Binary file removed src/excel/~$HealthRI_v2.0.2.xlsx
Binary file not shown.
4 changes: 2 additions & 2 deletions src/property/properties-adms_identifier.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
<td>notation</td>
<td>A string that is an identifier in the context of the identifier scheme referenced by its datatype.</td>
<td>skos:notation</td>
<td>xsd:string</td>
<td>rdfs:Literal</td>
<td>1..1</td>
<td>The value of this property is the alternative identifier of the dataset, next to the one indicated in the dct:identifier property.</td>
</tr>
<tr>
<td>schema agency</td>
<td>The name of the agency that issued the identifier.</td>
<td>adms:schemaAgency</td>
<td>xsd:string</td>
<td>rdfs:Literal</td>
<td>0..1</td>
<td>N.A.</td>
</tr>
Expand Down
8 changes: 6 additions & 2 deletions src/property/properties-agent.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,15 @@
</tr>
<tr>
<td>email</td>
<td>A email address via which contact can be made. This property SHOULD be used to provide the email address of the Agent, specified using fully qualified mailto: URI scheme [ RFC6068 ]. The email SHOULD be used to establish a communication channel to the agent.</td>
<td>A email address via which contact can be made. This property SHOULD be used to provide the email address of the Agent, specified using fully qualified mailto: URI scheme [&nbsp;&nbsp;RFC6068&nbsp;&nbsp;]. The email SHOULD be used to establish a communication channel to the agent.</td>
<td>foaf:mbox</td>
<td>rdfs:Resource&nbsp;&nbsp;(IRI)</td>
<td>1</td>
<td>It is preferred to provide a general email address of the appropriate institution or department instead of a personal email address, even if an individual is described with this instance of foaf:Agent.\nThis protects their privacy and enables contact about the resource even after the individual has left the institution.\n\nThe email address has to be provided starting with mailto: prefix.\nFor example: mailto:info@example.com</td>
<td>It is preferred to provide a general email address of the appropriate institution or department instead of a personal email address, even if an individual is described with this instance of foaf:Agent.
This protects their privacy and enables contact about the resource even after the individual has left the institution.

The email address has to be provided starting with mailto: prefix.
For example: mailto:info@example.com</td>
</tr>
<tr>
<td>identifier</td>
Expand Down
5 changes: 4 additions & 1 deletion src/property/properties-attribution.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@
<td>dcat:hadRole</td>
<td>rdfs:Resource (IRI)</td>
<td>0..1</td>
<td>Choose one of the roles as listed in the controlled vocabulary. Note that for HealthDCAT-AP, the list of roles might be extended in the future.\nExample: https://standards.iso.org/iso/19115/resources/Codelists/gml/CI_RoleCode.xml#processor<br><br><strong>Controlled vocabulary</strong><br>The value for the property must be selected from the specified vocabulary or list.<br><br><a href="https://standards.iso.org/iso/19115/resources/Codelists/gml/CI_RoleCode.xml">https://standards.iso.org/iso/19115/resources/Codelists/gml/CI_RoleCode.xml</a><br><a href="https://jats4r.niso.org/credit-taxonomy/#table-1-credit-terms-and-urls">https://jats4r.niso.org/credit-taxonomy/#table-1-credit-terms-and-urls</a><br></td>
<td>Choose one of the roles as listed in the controlled vocabulary. Note that for HealthDCAT-AP, the list of roles might be extended in the future.
Example: https://standards.iso.org/iso/19115/resources/Codelists/gml/CI_RoleCode.xml#processor

Next to the CI_RoleCode, we also propose to use the CRediT Taxonomy to specify roles of contributors.<br><br><strong>Controlled vocabulary</strong><br>The value for the property must be selected from the specified vocabulary or list.<br><br><a href="https://standards.iso.org/iso/19115/resources/Codelists/gml/CI_RoleCode.xml">https://standards.iso.org/iso/19115/resources/Codelists/gml/CI_RoleCode.xml</a><br><a href="https://jats4r.niso.org/credit-taxonomy/#table-1-credit-terms-and-urls">https://jats4r.niso.org/credit-taxonomy/#table-1-credit-terms-and-urls</a><br></td>
</tr>
</tbody>
</table>
25 changes: 15 additions & 10 deletions src/property/properties-catalogue.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<td>catalog</td>
<td>A catalog that is listed in the catalog.</td>
<td>dcat:catalog</td>
<td>dcat:Catalog (IRI)</td>
<td>dcat:Catalog</td>
<td>0..n</td>
<td>For certain research projects, multiple catalogs may need to be organized in a nested manner. This property serves to connect the different catalogs with each other.</td>
</tr>
Expand All @@ -32,22 +32,25 @@
<td>dcat:contactPoint</td>
<td>vcard:Kind</td>
<td>1</td>
<td>This property points to a contact point (department or person) that can answer questions about the catalogue. Details on how to describe these are provided under class vcard:Kind.\nWhenever possible, use a general contact information (for example from a department) instead of contact information of an individual.</td>
<td>This property points to a contact point that can answer questions about the dataset. Details on how to describe these are provided under class vcard:Kind.
Whenever possible, use a general contact information (for example from a department) instead of contact information of an individual.</td>
</tr>
<tr>
<td>creator</td>
<td>An entity responsible for making the resource.</td>
<td>dct:creator</td>
<td>foaf:Agent</td>
<td>0..n</td>
<td>Note that the Health-RI model diverges from DCAT-AP NL here, which reduces the maximum number of creators to 1. The Health-RI model allows specification of multiple creators of a catalogue.</td>
<td>The creator is the entity responsible for making the resource. According to Dutch databank and copyright law, this is in most cases the organisation / employer bearing investment risk, instead of an individual (e.g. individual researcher). Therefore, in many cases, this might be the same Agent as the dct:publisher, being the organisation (not a department or subdivision of the organisation) where the catalogue was created.
In case there are multiple (collaborating) organisation involved in data creation, all of them can be stated as dct:creator, as the model allows more than one creator.
Note that the Health-RI model diverges from DCAT-AP NL here, which reduces the maximum number of creators to 1. The Health-RI model allows the specification of multiple creators of a catalogue.</td>
</tr>
<tr>
<td>dataset</td>
<td>A dataset that is listed in the catalog.</td>
<td>dcat:dataset</td>
<td>dcat:Dataset</td>
<td>0..n</td>
<td>1..n</td>
<td>Each catalog contains one or more datasets. This property serves to link datasets to a catalogue. Therefore, a dataset is always contained inside a catalogue.</td>
</tr>
<tr>
Expand All @@ -70,9 +73,10 @@
<td>has part</td>
<td>A related resource that is included either physically or logically in the described resource.</td>
<td>dct:hasPart</td>
<td>dcat:Catalog (IRI)</td>
<td>dcat:Catalog</td>
<td>0..n</td>
<td>Use this property to establish another catalogue in this catalogue.\nNote that deeply nested structures should be avoided, and can currently not be displayed in the National Health Data Catalogue.</td>
<td>Use this property to establish another catalogue in this catalogue.
Note that deeply nested structures should be avoided, and can currently not be displayed in the National Health Data Catalogue.</td>
</tr>
<tr>
<td>home page</td>
Expand All @@ -88,7 +92,8 @@
<td>dct:language</td>
<td>dct:LinguisticSystem (IRI)</td>
<td>0..n</td>
<td>The value of this property must be an IRI from the provided controlled vocabulary.\nFor example: http://publications.europa.eu/resource/authority/language/NLD<br><br><strong>Controlled vocabulary</strong><br>The value for the property must be selected from the specified vocabulary or list.<br><br><a href="http://publications.europa.eu/resource/authority/language">http://publications.europa.eu/resource/authority/language</a><br></td>
<td>The value of this property must be an IRI from the provided controlled vocabulary.
For example: http://publications.europa.eu/resource/authority/language/NLD<br><br><strong>Controlled vocabulary</strong><br>The value for the property must be selected from the specified vocabulary or list.<br><br><a href="http://publications.europa.eu/resource/authority/language">http://publications.europa.eu/resource/authority/language</a><br></td>
</tr>
<tr>
<td>licence</td>
Expand Down Expand Up @@ -134,7 +139,7 @@
<td>service</td>
<td>A service that is listed in the catalog.</td>
<td>dcat:service</td>
<td>dcat:DataService (IRI)</td>
<td>dcat:DataService</td>
<td>0..n</td>
<td>Some datasets may have real-time Data Services (e.g., Beacon API counting individuals). IT teams should define the relationship between the catalog and the Data Service via this property. While crucial for interoperability, this property is not relevant for end-users to collect.</td>
</tr>
Expand All @@ -150,9 +155,9 @@
<td>themes</td>
<td>A main category of the resource. A resource can have multiple themes.</td>
<td>dcat:themeTaxonomy</td>
<td>skos:ConceptScheme (IRI)</td>
<td>skos:ConceptScheme</td>
<td>0..n</td>
<td>This property refers to a knowledge organisation system used to classify the Catalogue's Datasets. It must have at least the value NAL:data-theme as this is the mandatory controlled vocabulary for dcat:theme.<br><br><strong>Controlled vocabulary</strong><br>At least one of the provided values must come from the specified vocabulary (additional values from other sources may be included where relevant).<br><br><a href="http://publications.europa.eu/resource/authority/data-theme">http://publications.europa.eu/resource/authority/data-theme</a><br></td>
<td>This property refers to a knowledge organisation system used to classify the Catalogue's Datasets. It must have at least the value NAL:data-theme as this is the mandatory controlled vocabulary for dcat:theme.</td>
</tr>
<tr>
<td>title</td>
Expand Down
2 changes: 1 addition & 1 deletion src/property/properties-checksum.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<td>checksum value</td>
<td>The checksumValue property provides a lower case hexidecimal encoded digest value produced using a specific algorithm.</td>
<td>spdx:checksumValue</td>
<td>rdfs:Literal</td>
<td>xsd:hexBinary</td>
<td>1</td>
<td>N.A.</td>
</tr>
Expand Down
9 changes: 6 additions & 3 deletions src/property/properties-dataservice.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,18 @@
<td>dcat:contactPoint</td>
<td>vcard:Kind</td>
<td>1</td>
<td>This property points to a contact point (department or person) that can answer questions about the data service. Details on how to describe these are provided under class vcard:Kind.\nWhenever possible, use a general contact information (for example from a department) instead of contact information of an individual.</td>
<td>This property points to a contact point that can answer questions about the dataset. Details on how to describe these are provided under class vcard:Kind.
Whenever possible, use a general contact information (for example from a department) instead of contact information of an individual.</td>
</tr>
<tr>
<td>creator</td>
<td>An entity responsible for making the resource.</td>
<td>dct:creator</td>
<td>foaf:Agent</td>
<td>0..n</td>
<td>Note that the Health-RI model diverges from DCAT-AP NL here, which reduces the maximum number of creators to 1. The Health-RI model allows specification of multiple creators of a data service.</td>
<td>The creator is the entity responsible for making the resource. According to Dutch databank and copyright law, this is in most cases the organisation / employer bearing investment risk, instead of an individual (e.g. individual researcher). Therefore, in many cases, this might be the same Agent as the dct:publisher, being the organisation (not a department or subdivision of the organisation) where the catalogue was created.
In case there are multiple (collaborating) organisation involved in data creation, all of them can be stated as dct:creator, as the model allows more than one creator.
Note that the Health-RI model diverges from DCAT-AP NL here, which reduces the maximum number of creators to 1. The Health-RI model allows the specification of multiple creators of a catalogue.</td>
</tr>
<tr>
<td>rights</td>
Expand Down Expand Up @@ -166,7 +169,7 @@
<td>serves dataset</td>
<td>A collection of data that this data service can distribute.</td>
<td>dcat:servesDataset</td>
<td>dcat:Dataset (IRI)</td>
<td>dcat:Dataset</td>
<td>0..n</td>
<td>This property connects the Data Service class to its corresponding dataset(s), ensuring every data service links to at least one dcat:Dataset. While essential for metadata implementation teams on each node, it’s less relevant for researchers to collect.</td>
</tr>
Expand Down
Loading
Loading