Stream: IG creation
Topic: CodeSystem Stubs -- What is the Point?
Saul Kravitz (Aug 25 2020 at 22:18):
The IG publisher checks that ValueSets are valid, or at least the error messages make me feel that it does.
There is no similar check for code systems. I have defined valuesets using arbitrary URLs, and the IG publisher complains not one peep.
If I want to use a code system with a defining URL of http://whatever.org/something, I could create a CodeSystem stub -- a codeSystem that sets url=http://whatever.org/something. Alternatively, I could define a ValueSet that includes all codes from http://whatever.org/something. And I could start sprinkling codes using that system all over the place.
What is the value of defining a CodeSystem stub? Why not just start using the defining URL as if it as been defined as a CodeSystem?
In the published IG, the valuesets that reference the code system reference the defining URL, not the CodeSystem instance. Defining the CodeSystem in these cases seems like extra work that adds little value.
Jean Duteau (Aug 25 2020 at 22:22):
The only value is providing slightly more value to IG consumers about the code system if it isn't actually available via its URL. So if the code system is http://whatever.org/something and that doesn't actually resolve, then IG consumers can't see the details of the code system. For X12, we create the stubs so that we can provide more information about what the codes are (since we can't actually provide the codes) as well as provide the copyright information.
Jean Duteau (Aug 25 2020 at 22:24):
Rob Hausam had this to say in the #terminology stream about code system stubs (this was in relation to using a CodeSystem with content not present vs a NamingSystem):
The decision at least partly comes down to who is in control of the code system and how much and what types of metadata are available for it. The CodeSystem resource should represent the point of view and the content determined by the code system owner/publisher (although someone else, such as yourself, might actually create the resource instance). If the metadata includes the copyright and many of the additional items (including properties, filters, etc.), then CodeSystem is the only way that we have to represent that.
Saul Kravitz (Aug 26 2020 at 01:41):
OK, So we should view it as a place to put documentation. Therefore, better to err on the side of creating them. thx
Last updated: Apr 12 2022 at 19:14 UTC
