Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions

ValueSet: CDANullFlavor

Official URL: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor Version: 1.0.0
Draft as of 2024-12-18 Computable Name: CDANullFlavor

CDA NullFlavors - limited to values allowed in original CDA definition

References

Logical Definition (CLD)

Generated Narrative: ValueSet CDANullFlavor

  • Include these codes as defined in http://terminology.hl7.org/CodeSystem/v3-NullFlavor version 2.1.0
    CodeDisplayDefinition
    NPnot presentValue is not present in a message. This is only defined in messages, never in application data! All values not present in the message must be replaced by the applicable default, or no-information (NI) as the default of all defaults.
    NINoInformation**Description:**The value is exceptional (missing, omitted, incomplete, improper). No information as to the reason for being an exceptional value is provided. This is the most general exceptional value. It is also the default exceptional value.
    MSKmaskedThere is information on this item available but it has not been provided by the sender due to security, privacy or other reasons. There may be an alternate mechanism for gaining access to this information.

    Note: using this null flavor does provide information that may be a breach of confidentiality, even though no detail data is provided. Its primary purpose is for those circumstances where it is necessary to inform the receiver that the information does exist without providing any detail.
    NAnot applicableKnown to have no proper value (e.g., last menstrual period for a male).
    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.
    NINFnegative infinityNegative infinity of numbers.
    PINFpositive infinityPositive infinity of numbers.
    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.)
    NASKnot askedThis information has not been sought (e.g., patient was not asked)
    TRCtraceThe content is greater than zero, but too small to be quantified.
    ASKUasked but unknownInformation was sought but not found (e.g., patient was asked but didn't know)
    NAVtemporarily unavailableInformation is not available at this time but it is expected that it will be available later.

 

Expansion

Generated Narrative: ValueSet

Expansion based on codesystem NullFlavor v2.1.0 (CodeSystem)

This value set contains 12 concepts

CodeSystemDisplayInactiveDefinition
  NPhttp://terminology.hl7.org/CodeSystem/v3-NullFlavornot presentinactive

Value is not present in a message. This is only defined in messages, never in application data! All values not present in the message must be replaced by the applicable default, or no-information (NI) as the default of all defaults.

  NIhttp://terminology.hl7.org/CodeSystem/v3-NullFlavorNoInformation

**Description:**The value is exceptional (missing, omitted, incomplete, improper). No information as to the reason for being an exceptional value is provided. This is the most general exceptional value. It is also the default exceptional value.

  MSKhttp://terminology.hl7.org/CodeSystem/v3-NullFlavormasked

There is information on this item available but it has not been provided by the sender due to security, privacy or other reasons. There may be an alternate mechanism for gaining access to this information.

Note: using this null flavor does provide information that may be a breach of confidentiality, even though no detail data is provided. Its primary purpose is for those circumstances where it is necessary to inform the receiver that the information does exist without providing any detail.

  NAhttp://terminology.hl7.org/CodeSystem/v3-NullFlavornot applicable

Known to have no proper value (e.g., last menstrual period for a male).

  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.

  NINFhttp://terminology.hl7.org/CodeSystem/v3-NullFlavornegative infinity

Negative infinity of numbers.

  PINFhttp://terminology.hl7.org/CodeSystem/v3-NullFlavorpositive infinity

Positive infinity of numbers.

  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.)
  NASKhttp://terminology.hl7.org/CodeSystem/v3-NullFlavornot asked

This information has not been sought (e.g., patient was not asked)

  TRChttp://terminology.hl7.org/CodeSystem/v3-NullFlavortrace

The content is greater than zero, but too small to be quantified.

  ASKUhttp://terminology.hl7.org/CodeSystem/v3-NullFlavorasked but unknown

Information was sought but not found (e.g., patient was asked but didn't know)

  NAVhttp://terminology.hl7.org/CodeSystem/v3-NullFlavortemporarily unavailable

Information is not available at this time but it is expected that it will be available later.


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