Maintenance Alert - This service will be undergoing planned maintenance from Tuesday 23 April 2024, 07:00UTC until Tuesday 23 April 2024, 09:00UTC. During this time the service will be unavailable.
...
Case sensitivity: To be discussed.
10 July 2018
Determined that it would be best to have multiple response parameters to capture the various possible scenarios so the client can choose the correct behaviour. Specifically discussed was adding a well known set of extension parameters which can be considered as optional response parameters in the specification in future.
The table below is intended to be built out to cover the various scenarios. Note that the philosophy with the boolean result parameter from validate-code is that it should return true if the code is correct, and only false if the text provided does not match at all, this is considered most fault tolerant for clients that don't use the additional parameters to discern the result more closely.
| scenario | result | message | display | code validity code | display validity code | ||
|---|---|---|---|---|---|---|---|
| code | term | ValueSet term | |||||
| valid code | no term | no | true | code system preferred display | valid code in ValueSet | - | |
| valid code | no term | yes | true | ValueSet display for code | valid code in ValueSet | - | |
| code not in ValueSet | no term | n/a | false | explanation the code is invalid | code system preferred display | valid code not in ValueSet | - |
| code not in ValueSet | preferred display | n/a | false | explanation the code is invalid | code system preferred display | valid code not in ValueSet | correct display term |
| code not in ValueSet | acceptable term | n/a | false | explanation the code is invalid and warning that the display was not the preferred display | code system preferred display | valid code in ValueSet | acceptable display term |
| code not in ValueSet | active but unacceptable term for locale | n/a | false | explanation the code is invalid and warning that the display matches an active term for the code, but not an acceptable one | code system preferred display | valid code in ValueSet | active display term |
| code not in ValueSet | inactive/historical term for code | n/a | false | explanation the code is invalid and warning the provided term is historical for the code and not active | code system preferred display | valid code in ValueSet | historical display term |
| code not in ValueSet | unknown term for code system | n/a | false | explanation the code is invalid and explanation that the term was unknown | code system preferred display | valid code in ValueSet | unknown term |
| valid code | preferred display | no | true | code system preferred display | valid code in ValueSet | correct display term | |
| valid code | preferred display | yes | true | explanation the display was valid for the code but didn't match the ValueSet | ValueSet display for code | valid code in ValueSet | correct display term |
| valid code | acceptable term | no | true | warning that the display was not the preferred display | code system preferred display | valid code in ValueSet | acceptable display term |
| valid code | acceptable term | yes | true | explanation the display was not preferred for the code and didn't match the ValueSet | ValueSet display for code | valid code in ValueSet | correct display term |
| valid code | active but unacceptable term for locale | no | true | warning that the display matches an active term for the code, but not an acceptable one | code system preferred display | valid code in ValueSet | active display term |
| valid code | active but unacceptable term for locale | yes | true | warning the display was not acceptable for the code and didn't match the ValueSet | ValueSet display for code | valid code in ValueSet | correct display term |
| valid code | inactive/historical term for code | no | true | warning the provided term is historical for the code and not active | code system preferred display | valid code in ValueSet | historical display term |
| valid code | inactive/historical term for code | yes | true | warning the provided term is historical for the code and didn't match the ValueSet | ValueSet display for code | valid code in ValueSet | correct display term |
| valid code | unknown term for code system | no | false | explanation that the term was unknown | code system preferred display | valid code in ValueSet | unknown term |
| valid code | unknown term for code system | yes | true | ValueSet display for code | valid code in ValueSet | correct display term | |
| known code for code system family, but not in code system version | no term | n/a | false | explanation the code was not valid for the code system version | code system preferred display | known code not in code system version | - |
| known code for code system family, but not in code system version | preferred display | n/a | false | explanation the code was not valid for the code system version | code system preferred display | known code not in code system version | correct display term |
| known code for code system family, but not in code system version | acceptable term | n/a | false | explanation the code was not valid for the code system version | code system preferred display | known code not in code system version | acceptable display term |
| known code for code system family, but not in code system version | active but unacceptable term for locale | n/a | false | explanation the code was not valid for the code system version | code system preferred display | known code not in code system version | active display term |
| known code for code system family, but not in code system version | inactive/historical term for code | n/a | false | explanation the code was not valid for the code system version | code system preferred display | known code not in code system version | historical display term |
| known code for code system family, but not in code system version | unknown term for code system | n/a | false | explanation the code was not valid for the code system version | code system preferred display | known code not in code system version | unknown term |
| syntactically valid code (i.e. concept SCTID) but not known to any version on the server | unknown or no term | n/a | false | explanation the code was not valid for any known version for this code system | - | unknown but syntactically valid code | |
| valid identifier for component other than a concept (e.g. description or relationship) | unknown or no term | n/a | false | explanation the code is not for the right type of component | - | incorrect identifier type | |
| syntactically invalid code | unknown or no term | n/a | false | explanation the code is syntactically invalid, doesn't meet the code system's scheme | - | code not valid for code system scheme | |
code validity and display validity are intended to be extensible bindings to a Code datatype.
This table needs further refinement and consideration of particularly whether all scenarios are worth the effort. Description handling is somewhat SNOMED CT specific, but generalisable to other code systems as most would fall under a subset of the scenarios (i.e. may not draw all the distinctions SNOMED CT does wrt term preferences).
Case significance status in SNOMED CT should also be taken into account, so "Heart structure" and "heart structure" would be matched equally for 80891009 and get the same display validity code as they are equivalent once case significance is taken into account.