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

Ethical issues report data type should be changed to string #85

Open
ValentinFutterer opened this issue Jan 15, 2025 · 2 comments
Open
Labels
identifiers Issue related to IDs

Comments

@ValentinFutterer
Copy link

Currently the data type is URI. However, European ethics committees usually give reference numbers for their reports, which cannot be used within a URL, such as https://ethics-commitee/reports?reference_number=xxxxxxxx, where xxxxxxxx would be the number. Such services are not provided by the committees. Therefore, we should change the format to string, as there is no benefit in enforcing a URI format.

@MarekSuchanek
Copy link
Collaborator

This seems like ethical_issues_report should be actually some identifier following the structure we have elsewhere (ID with value and type). If we just make this string, and there is a reference number, we do not allow to capture what kind of identifier it is, right?

In any case, I think this could be a breaking change as systems might rely on this being URL (e.g. rendering it as a link).

@MarekSuchanek MarekSuchanek added the identifiers Issue related to IDs label Feb 26, 2025
@ValentinFutterer
Copy link
Author

I dont know exact details, but the people I talked to told me, that these numbers dont necessarily follow standards we can use as identifier type. Seems like everyone does their own thing. We would have to collect all the different identifier types from the commissions, or we just use "other" to capture all irregular ones.

If we keep the number as string, you could use built in URL checks in the tools to decide, if it should be rendered as a URL or not (although this would still be breaking).

If we use the ID + type approach, we would need to store some kind of information on how to build an URL out of the ID, if we want to keep this functionality. If we make this field a string, the tools would be responsible for guiding users to input this number as an URL.

Both solutions dont seem very "clean" to me, and the decision might require more info from the ethic commissions on how they structure their identifiers.

About the breaking change: The datatype beforehand was URI, which would have allowed for URNs - although this could be a little pedantic, since I think everyone understood this datatype as URL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
identifiers Issue related to IDs
Projects
None yet
Development

No branches or pull requests

2 participants