Naming Conventions for Refsets
Hi all
We're considering a minor change to the naming conventions of refsets in some extensions, to allow for more flexibility with changing the names/descriptions of the refsets. This would start with a trial for the New Zealand extension, and potentially also the Estonian and Swedish extensions.
Currently the naming convention includes a human readable description in the filename, explaining roughly what the refset is. However, not only are these now frequently subject to change (which causes problems with both maintenance and consumption of the files), but also many of them are becoming far too long to be fit for purpose.
The Release File Spec (https://snomed.atlassian.net/wiki/display/DOCRELFMT/3.3.2+Release+File+Naming+Convention) states that this is an "optional" summary of the usage of the file, and so isn't a requirement.
The proposal would be to replace the description with the RefsetID instead - thus
a) removing all of the problems (described above) that long descriptions entail, plus
b) still retaining a link through to the Refset (and to the description if users simply plug it into the browser) for those wanting to know what the file contains before opening it.
We have identified a few potential minor drawbacks:
a) the fact that the naming convention would differ from the other extensions, and also to files within the same NZ extension (such as their Lang refset files, etc) leaves room for confusion for users +
b) users might have already hard coded import routines +
c) If the file contains MULTIPLE refset of the same RefsetType (but different RefsetID's), then which refsetID do we use in the name of the file?
d) Will we do this for Map files too? (as they're technically just a type of Refset)
If so, then:
Same issue as c) above - For example, the SimpleMap refset file in the INT Edition contains multiple Maps (ICD-0 + CTV-3)
We may need to consider splitting the INT Map files into 2x separate files:
In which case would we need to consult with the community for such as a change?
Check with Implementation Team regarding any potential impact to the Simplex rollout if we DON'T change the Map file naming conventions now?
However, the benefits still appear to significantly outweigh the potential issues.
The plan would be to make the changes in the NZ (and potentially other) extensions in the Q4 cycle of 2024, and therefore we would need to communicate this out several months in advance in order to provide sufficient notice for users.
Therefore, if you can see any other potential problems, or have a strong opinion either way, please can you let us know ASAP?
Thanks very much!
Andrew
So I thought managed service only outputted a single file per refset pattern... So it was news to me that other NRCs had a "file per refset".
We currently have file per refset also (but moving to file per pattern once we go to managed service).
And have also expereienced both the issues you've mentioned.
We updated a refset preferred term once, which broke a vendors import process. The had hard-coded the file name.
We've also got a request to update the name for one of our third party refsets - but we've postponed that until we change our naming convention.
And we/our users hit the file name length issue often. It's a Windows problem.
I think replacing the name with something persistent like the refsetId is fine.
Drawbacks:
"the naming convention would differ from the other extensions" - we've already got two conventions - file per refset, file per pattern. The different naming conventions is trivial in that context. They're only relevant to humans.
Automated processes should handle either (ie. if somebody hard codes the file name).
der2_Refset_AjccGradeSimpleRefsetSnapshot_NZ1000210_{date}.txt
der2_Refset_253251000210103SimpleRefsetSnapshot_NZ1000210_{date}.txt
I don't see this different naming convention as an issue between NRCs. The only issue is file name changes, for hard coded implementations.
BUT... the REAL ISSUE here is that we've got different file/bundle structures across NRCs.
(Of course a smart vendor could easily could import all the refsets regardless of convention, so long as the pattern is consistent - import "der2_Refset_*Snapshot_*.txt"
As an aside, the April NZ release seems to be broken/corrupt. (I can't open the file, downloaded twice. No problem with October) @Andrew Atkinson