Stream: terminology
Topic: Parameters to $validate-code
Grahame Grieve (Oct 17 2021 at 21:14):
The following parameters defined on $expand should also be defined on $validate-code for CodeSystem and ValueSet (and I have supported them always):
- displayLanguage
- activeOnly
- excludePostCoordinated
- system-version
- check-system-version
- force-system-version
For display language for both $expand and $validate-code we should document that it overrides the HTTP Accept-Language header, if present.
Grahame Grieve (Oct 17 2021 at 21:18):
Beyond this, I'd like to add another parameter for $validate-code: default-to-latest-version (or similar). If this is set to true, then the terminology server will use the version specified, if it can, else it will default to the latest version for the system (or edition, to SCT).
The requirement driving this is that $validate-code is often used for looking up display values (it's simpler and quicker and more ubiquitous than $lookup), and you want the correct version display if you can get it, but not an error if the server can't match the version
Michael Lawley (Oct 17 2021 at 21:18):
For clarity, can you confirm that displayLanguage only affects the returned result, and not the success/failure of the validation itself?
Grahame Grieve (Oct 17 2021 at 21:20):
well, that's a very good question, but no, I can't confirm that because in my implementation, it does drive the validation of the display
Michael Lawley (Oct 17 2021 at 22:04):
My understanding was that $validate-code should only check that the supplied display is a valid display for the code. I've interpreted this as "regardless of language"
Peter Jordan (Oct 17 2021 at 22:06):
Assuming that you are referring to input parameters, I'm not sure about the need for a new one for system-version when CodeSystem/$validate-code already has a system parameter and ValueSet/$validate-code a systemVersion parameter. What might I be missing here?
Grahame Grieve (Oct 17 2021 at 22:19):
@Michael Lawley I give a warning if the display is valid for the code but not in the language specified
Grahame Grieve (Oct 17 2021 at 22:20):
@Peter Jordan system is the system of the code, and systemVersion is the version of the system. but system-version is the version to use for a system if the coding doesn't specify a sytemVersion (or a system in a codeableConcept, for example)
Peter Jordan (Oct 17 2021 at 22:35):
@Grahame Grieve Is the distinction that you're making between the version of a Code System and that of an individual code within a coding or codeableConcept that's passed?
Grahame Grieve (Oct 17 2021 at 22:38):
the distinction between systemVersion and system-version? Those names are unfortunate, but one is the data from the instance, and the other is a configuration setting to override the data in the instance.
Michael Lawley (Oct 17 2021 at 22:44):
Thinking this through, if CodeSystem.versionNeeded=false, do these parameters matter? And, if CodeSystem.versionNeeded=true, then they'd need to be the same otherwise the result must be false?
Grahame Grieve (Oct 17 2021 at 22:53):
yes I think they still matter, because they are an expression of operational policy, where as CodeSystem.versionNeeded is a statement about that the operational policy should be - and those are not the same thing
Reuben Daniels (Dec 20 2021 at 20:34):
Hi @Grahame Grieve
Have Jira tickets been created for these proposed changes? If not, can you please create them for discussion in the Vocabulary WG FHIR Tracker calls?
Thanks
Last updated: Apr 12 2022 at 19:14 UTC
