Investigate the change of the identifier format in the FHIR Library resource

[baseTwo]

The format of the id in a FHIR Library Resource was changed from {libraryName}-{libraryVersion} to {libraryName} in this PR

• update canonicals of the library and dependent libraries #384

Please look into why this was needed, since there is a need to have resources with duplicate names but diferent versions

[baseTwo]

@and-hus would you add more detail to this ticket so that @richfirely could pick it up?

[alexzautke]

+1 for {libraryName}-{libraryVersion}

[richfirely]

I researched and this was done to simplify tracking in FHIR servers. I'd like to take this opportunity to outline how ID and other identifying fields should look and get feedback. Stay tuned for the next comment.

[richfirely]

Make the following adjustments to Library Resource:

Field	Format	C#	Comments
Id	libraryName-libraryVersion	elmLibrary.GetVersionedIdentifier()	Move back to both name and version. This will break file generation due to dash checking. See Name.
Version	libraryVersion	elmLibrary.identifier?.version!	Remains the same
Name	libraryName	elmLibrary.identifier?.id!	Remains the same. Use this for file name generation. https://hl7.org/fhir/R4/library-definitions.html#Library.name
Url	RootUrl/Library/Name	Library.CanonicalUri(resourceCanonicalRootUrl)	Switch to elmLibrary.identifier?.Id! (Library.Name) https://hl7.org/fhir/R4/library-definitions.html#Library.url This extension seems misnamed or unintended. Given the name, I would expect this extension to result in a canonical reference with version, if exists. Url is uri datatype and should not include version. Retire. Create alternative logic.
relatedArtifact resource	RootUrl/Library/Name|Version

Perform similar alignment for Measure resource.

• Measure.Library RootUrl/Library/Name|Version

Code Adjustments:

• Retire Resource.CanonicalUri
• WriteToFileFhirResourcePostProcessor - replace Id with Name.
• ResourceFileNames - change Id to name for consistency and avoid future confusion.
• ResourcePackager - adjust fields as above. Refactor, comment, and cleanup in prep for future PR for measure templates.
• Consider overload to GetVersionedIdentifier to change the delimiting character, such as pipe for generating part of the full canonical for Measure.Library.
• Fix bug where Library.Parameters contains valuesets as IN parameters. Move to related artifact.

Suggestions/concerns are welcome.

[alexzautke]

Counterpoint to "Remains the same. Use this for file name generation." for file name generation:
https://hl7.org/fhir/uv/cql/conformance.html is saying that the filename for the CQL file should be "-.cql", so I'd suggest that "-< libraryVersion>.json" should be the filename for the Library.

[richfirely]

Counterpoint to "Remains the same. Use this for file name generation." for file name generation: https://hl7.org/fhir/uv/cql/conformance.html is saying that the filename for the CQL file should be "-.cql", so I'd suggest that "-< libraryVersion>.json" should be the filename for the Library.

That is correct now and will stay that way. My item was about using Library.Name - elmLibrary.identifier.id as the input for file name generation. It is using Library.Id right now, which is changing back to have the dash version suffix so it cannot continue to be used.

[alexzautke]

Ah got it. Thanks.

[and-hus]

The resource field in relatedArtifact has a format of <RootUrl>/Library/<Name>|<Version> - mind the pipe symbol as a separator...

What do you think about using the pipe symbol for the Id as well:
<Name>|<Version> ?

[alexzautke]

What do you think about using the pipe symbol for the Id as well

The id datatype does not allow for this

[alexzautke]

Ups, wrong button :D

[and-hus]

The id datatype does not allow for this

Aaah, you are right, Id allows only [A-Za-z0-9\-\.]{1,64} ...
Sorry, I should have checked first ;-)

[and-hus]

The proposal looks good to me.
Nothing to add from my end.

Thanks for picking it up ;-)