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

516 ON-HOLD Prepend resource type (eg Library or Measure) to resource file extension #531

Draft
wants to merge 4 commits into
base: develop-2.0
Choose a base branch
from

Conversation

baseTwo
Copy link
Collaborator

@baseTwo baseTwo commented Sep 11, 2024

Work for #516

⚠️ DO NO MERGE -- Must be discussed at September WGM as this is not per spec.

Prepend resource type (eg Library or Measure) to resource file extension, since there could be overwrites on the same file when the resource is both

eg.

AAB_Reporting.library.json
AAB_Reporting.measure.json

Must have settings to enable this or not

@baseTwo baseTwo changed the title Prepend resource type (eg Library or Measure) to resource file name 516 Prepend resource type (eg Library or Measure) to resource file name Sep 11, 2024
@baseTwo baseTwo marked this pull request as ready for review September 11, 2024 14:07
Copy link
Collaborator Author

@baseTwo baseTwo left a comment

Choose a reason for hiding this comment

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

Think about other formats e.g. Having the resource type name as part of the file extension, eg. Reporting.Library.json.
Consider that this file name change effects resource loading of dependencies.

@baseTwo baseTwo changed the title 516 Prepend resource type (eg Library or Measure) to resource file name 516 Prepend resource type (eg Library or Measure) to resource file extension Sep 11, 2024
@baseTwo
Copy link
Collaborator Author

baseTwo commented Sep 12, 2024

Must be discussed at September WGM. Must have settings to enable this or not

@baseTwo baseTwo marked this pull request as draft September 12, 2024 15:46
…ing-the-library-resource-file-measure-output-incomplete
@baseTwo baseTwo added Packaging bug Something isn't working and removed bug Something isn't working Packaging labels Sep 13, 2024
…ing-the-library-resource-file-measure-output-incomplete
@baseTwo baseTwo changed the title 516 Prepend resource type (eg Library or Measure) to resource file extension 516 ON-HOLD Prepend resource type (eg Library or Measure) to resource file extension Sep 16, 2024
@richfirely
Copy link
Contributor

richfirely commented Oct 1, 2024

@baseTwo Based on this doc:
https://build.fhir.org/ig/HL7/cql-ig/conformance.html
CQL library source files SHOULD be named CQLLibraryName-Version.cql

I think that we should go with the format when writing to file system
Library-LibraryName-Version.json
Measure-MeasureName-Version.json

This way it mimics more closely the source cql recommendation.

I think we should merge this change with the modification stated above, so that the measure building isn't overwriting the library files. We agreed at WGM that building measures from CQL annotations was a good value add to the SDK. For now, just fixing the "bug" of overwriting is more important.

The settings part and output still needs design. I have some code started for this which I will submit in a future PR.

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.

Measure library creation overwriting the library resource file. Measure output incomplete.
2 participants