eHDSI Terminologies
0.1.0 - ci-build

eHDSI Terminologies, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/EHDSI-Terminology-package/ and changes regularly. See the Directory of published versions

ValueSet: eHDSI Exceptional Value

Official URL: http://hl7europe.org/fhir/terminology/ehdsi/ValueSet/eHDSIExceptionalValue Version: 0.1.0
Draft as of 2024-11-03 Computable Name: eHDSIExceptionalValue
Other Identifiers: UUID:eHDSIExceptionalValue

The Value Set is used to code exceptional values for the required binding in FHIR IGs

References

This value set is not used here; it may be used elsewhere (e.g. specifications and/or implementations that use this content)

Logical Definition (CLD)

Generated Narrative: ValueSet eHDSIExceptionalValue

  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor
    CodeDisplayDefinition
    OTHother**Description:**The actual value is not a member of the set of permitted data values in the constrained value domain of a variable. (e.g., concept not provided by required code system).

    **Usage Notes**: This flavor and its specializations are most commonly used with the CD datatype and its flavors. However, it may apply to \*any\* datatype where the constraints of the type are tighter than can be conveyed. For example, a PQ that is for a true measured amount whose units are not supported in UCUM, a need to convey a REAL when the type has been constrained to INT, etc.

    With coded datatypes, this null flavor may only be used if the vocabulary binding has a coding strength of CNE. By definition, all local codes and original text are part of the value set if the coding strength is CWE.
    UNKunknown**Description:**A proper value is applicable, but not known.

    **Usage Notes**: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

    1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
    2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)
    UNCun-encoded**Description:** The actual value has not yet been encoded within the approved value domain.

    **Example**: Original text or a local code has been specified but translation or encoding to the approved value set has not yet occurred due to limitations of the sending system. Original text has been captured for a PQ, but not attempt has been made to split the value and unit or to encode the unit in UCUM.

    **Usage Notes**: If it is known that it is not possible to encode the concept, OTH should be used instead. However, use of UNC does not necessarily guarantee the concept will be encodable, only that encoding has not been attempted.

    Data type properties such as original text and translations may be present when this null flavor is included.

 

Expansion

Generated Narrative: ValueSet

Expansion based on codesystem NullFlavor v3.0.0 (CodeSystem)

This value set contains 3 concepts

CodeSystemDisplayDefinition
  OTHhttp://terminology.hl7.org/CodeSystem/v3-NullFlavorother

**Description:**The actual value is not a member of the set of permitted data values in the constrained value domain of a variable. (e.g., concept not provided by required code system).

Usage Notes: This flavor and its specializations are most commonly used with the CD datatype and its flavors. However, it may apply to *any* datatype where the constraints of the type are tighter than can be conveyed. For example, a PQ that is for a true measured amount whose units are not supported in UCUM, a need to convey a REAL when the type has been constrained to INT, etc.

With coded datatypes, this null flavor may only be used if the vocabulary binding has a coding strength of CNE. By definition, all local codes and original text are part of the value set if the coding strength is CWE.

  UNKhttp://terminology.hl7.org/CodeSystem/v3-NullFlavorunknown

**Description:**A proper value is applicable, but not known.

Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:

  1. Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown')
  2. Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)
  UNChttp://terminology.hl7.org/CodeSystem/v3-NullFlavorun-encoded

Description: The actual value has not yet been encoded within the approved value domain.

Example: Original text or a local code has been specified but translation or encoding to the approved value set has not yet occurred due to limitations of the sending system. Original text has been captured for a PQ, but not attempt has been made to split the value and unit or to encode the unit in UCUM.

Usage Notes: If it is known that it is not possible to encode the concept, OTH should be used instead. However, use of UNC does not necessarily guarantee the concept will be encodable, only that encoding has not been attempted.

Data type properties such as original text and translations may be present when this null flavor is included.

Explanation of the columns that may appear on this page:

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
System The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance)
Display The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code