Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature/model update v3 #49

Merged
merged 108 commits into from
Oct 28, 2024
Merged

feature/model update v3 #49

merged 108 commits into from
Oct 28, 2024

Conversation

fdiehr
Copy link
Contributor

@fdiehr fdiehr commented Apr 30, 2024

PR Context

We need to update our metadata model due to new insights deriving from a) consulting more standards and schemas specific to the modelling of health data, like upcoming profile "HealthDCAT-AP" in relation to the development of the EHDS (European Health Data Space).
Further, we introduce a new entity called "bibliographic reference". This new entity allows us to describe bibliographic references, e.g. publications (books, book sections, journal articles). With that, we added a new core entity to our metadata catalogue, which provides valuable information about RKI's research.

Added

  • Entity bibliographic reference
  • Vocabulary bibliographic-reference-type: a list of different publication types.
  • Vocabulary resource-creation-method: we want to have a better distinction between the usage of resourceTypeGeneral as a generic type for resources and the context/method of how the resources were created.
  • Vocabulary personal-data: we want to be able to say, if a resource contains personal data or not.
  • Added JSON Schema property description to all entities and properties, since we delete the specification of the model (docs/index.md)

resource

  • Property conformsTo: Providing information about standards used with the resource.
  • Property doi: For published resources.
  • Property hasLegalBasis: Information about the legal basis on which the data was processed; inspired by HealthDCAT-AP draft and Data Privacy Vocabulary
  • Property hasPersonalData: Information if the resource contains personal data or not ;inspired by HealthDCAT-AP draft and Data Privacy Vocabulary
  • Property maxTypicalAge and minTypicalAge: Information about the age of the researched population; inspired by HealthDCAT-AP draft
  • Property populationCoverage: Information about the researched population; inspired by HealthDCAT-AP draft
  • Property resourceCreationMethod: Information about the context or method used in order to create the resource

Changes

all entities

  • Property identifierInPrimarySource has now a "minLength" and "maxLength" and has a pattern to restrict newlines

variable

  • Property dataType does not expect a vocabulary item anymore, but a string

activity

  • Property publication is now expecting the identifier of bibliographic-reference item

resource

  • Property publication is now expecting the identifier of a bibliographic reference item
  • Property loincId: new pattern

distribution

  • Properties accessURL and downloadURL now have the type "array", because there can be multiple repositories for accessing the distribution (e.g. GitHub, Zenodo).
  • Deleted some properties: We want only to have properties that are relevant for the distribution's access. Hence, all properties concerning actors involved in the creation of the resource were deleted.

vocabularies

  • theme: It had too many concepts and was not suitable for our purposes. We decided to delete most of the concepts and keep only the main topics of RKI.
  • activity: Deleted concepts due to discussions: We want to focus on the distinction between third-party funded projects and internal projects.
  • resource-type-general: Deleted and added concepts due to discussions: We have consulted other standards and schemas (e.g. NFDI4Health, DataCite) to find more suitable resource types; although we didn't find a perfect fit for the vocabulary, we found a few useful concepts and added some of them.

date properties

  • Defined new patterns for dates: YearMonthDay, YearMonth, Year. Delete "format": "date" and "format": "datetime" to ensure validation.

index.md
Deleted all information that were relevant to the "specification" of the model. We decided, that the maintenance of the specification is not worth its benefit (mainly interoperability with standards). In the future, it is more feasible and fitting to our use case to maintain mappings to the portals we will contribute to.
But we want to keep the index file, because we may add some more description on the schema on a more general level.

README.md

  • Transferred contact and publisher information from index.md to README

Removed

  • Vocabulary data-type.json because we decided against having a controlled vocabulary for data types.

fdiehr and others added 28 commits April 30, 2024 14:58
required fields

Signed-off-by: FranziDiehr <[email protected]>
Added vocabulary "bibliographic-reference-type" to the list of concept schemes.

Signed-off-by: FranziDiehr <[email protected]>
updated name of property and $ref to the vocabulary

Signed-off-by: FranziDiehr <[email protected]>
changed datatype property to not expect a vocabulary item

Signed-off-by: FranziDiehr <[email protected]>
changed property pubilication to expect the identifier of bibliographic reference item

Signed-off-by: FranziDiehr <[email protected]>
changed property publication to expect identifier of bibliographic reference item

Signed-off-by: FranziDiehr <[email protected]>
added property a new property "standardsUsed" as discussed

Signed-off-by: FranziDiehr <[email protected]>
fixed error

Signed-off-by: FranziDiehr <[email protected]>
changed property accessURL and download URL to type array, because there can be multiple repositories for accessing th edistribution (e.g. GitHub, Zenodo)
added pattern for loincId
we decided against having a controlled vocabulary for data types
first draft, more concepts to be added
added descriptions for properties
added descriptions to properties
added description to properties
added descriptions to properties
added descriptions to properties
added descriptions to properties
added descriptions to properties
added descriptions to properties
added descriptions to properties and description to the entity
added descriptions to properties and description to entity
added description to property and entity
added descriptions to properties
typo

Co-authored-by: LeipoldL <[email protected]>
Signed-off-by: FranziDiehr <[email protected]>
@fdiehr fdiehr requested a review from cutoffthetop July 10, 2024 13:49
cutoffthetop
cutoffthetop previously approved these changes Jul 10, 2024
mr-kamran-ali and others added 21 commits August 8, 2024 16:55
… we need a general term for resources, that cannot be mapped to a specific theme
# PR Context
We need to introduce consents given by persons in order to be able to
publish their names and contact information in the metadata catalog.

# Added
Created consent entity and two new vocabularies.
Added the vocabularies to concept-schemes.json

---------

Signed-off-by: FranziDiehr <[email protected]>
Co-authored-by: Nicolas Drebenstedt <[email protected]>
- drop anyOf from hasConsentStatus since we allow just one type
- remove default from hasConsentStatus since we need it required
- add identifierInPrimarySource to required fields
# PR Context
<!-- Additional info for the reviewer -->

# Added
<!-- New features and interfaces -->
- release script, creating merged-models. Merged models are written to a
zip file, together with the content of the following directories: i18n,
fields, vocabularies.
# Changes
- new metadata fields included

# Removed
- outdated metadata fields removed

---------

Signed-off-by: LeipoldL <[email protected]>
Signed-off-by: FranziDiehr <[email protected]>
Co-authored-by: Franziska Diehr <[email protected]>
Co-authored-by: FranziDiehr <[email protected]>
# PR Context
- cruft update

---------

Signed-off-by: erichesse <[email protected]>
Copy link
Contributor

@LeipoldL LeipoldL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes approved

@cutoffthetop cutoffthetop merged commit 2a296a1 into main Oct 28, 2024
3 checks passed
@cutoffthetop cutoffthetop deleted the feature/model-update-v3 branch October 28, 2024 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants