V3-NullFlavor.xml

A collection of codes specifying why a valid value is not present.

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="v3-NullFlavor"/>
  <meta>
    <lastUpdated value="2015-07-31T00:00:00.000+10:00"/>
    <profile value="http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p>Release Date: 2015-07-31</p>

      <p>OID for code system: 2.16.840.1.113883.5.1008</p>

      <p>OID for value set: 2.16.840.1.113883.1.11.10609 (this is the value set that includes the
           entire code system)</p>

      <h2>Description</h2>

      <p>
                  A collection of codes specifying why a valid value is not present.
        <br/>

               
      </p>

      <hr/>

      <table class="grid">
 
        <tr>
          <td>
            <b>Level</b>
          </td>
          <td>
            <b>Code</b>
          </td>
          <td>
            <b>Display</b>
          </td>
          <td>
            <b>Definition</b>
          </td>
        </tr>
 
        <tr>
          <td>1</td>
          <td>NI
            <a name="NI"> </a>
          </td>
          <td>NoInformation</td>
          <td>
                        
                           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.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  INV
            <a name="INV"> </a>
          </td>
          <td>invalid</td>
          <td>
                        
                           Description:The value as represented in the instance is not
               a member of the set of permitted data values in the constrained value domain of a variable.
               
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>3</td>
          <td>    DER
            <a name="DER"> </a>
          </td>
          <td>derived</td>
          <td>
                        
                           Description:An actual value may exist, but it must be derived
               from the provided information (usually an EXPR generic data type extension will be used
               to convey the derivation expressionexpression .
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>3</td>
          <td>    OTH
            <a name="OTH"> </a>
          </td>
          <td>other</td>
          <td>
                        
                           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).
            <br/>

                        
                           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.
            <br/>

                        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.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>4</td>
          <td>      NINF
            <a name="NINF"> </a>
          </td>
          <td>negative infinity</td>
          <td>
                        Negative infinity of numbers.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>4</td>
          <td>      PINF
            <a name="PINF"> </a>
          </td>
          <td>positive infinity</td>
          <td>
                        Positive infinity of numbers.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>3</td>
          <td>    UNC
            <a name="UNC"> </a>
          </td>
          <td>un-encoded</td>
          <td>
                        
                           Description: The actual value has not yet been encoded within
               the approved value domain.
            <br/>

                        
                           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.
            <br/>

                        
                           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.
            <br/>

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

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  MSK
            <a name="MSK"> </a>
          </td>
          <td>masked</td>
          <td>
                        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.
            <br/>

                        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.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  NA
            <a name="NA"> </a>
          </td>
          <td>not applicable</td>
          <td>
                        Known to have no proper value (e.g. last menstrual period for
               a male).
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>2</td>
          <td>  UNK
            <a name="UNK"> </a>
          </td>
          <td>unknown</td>
          <td>
                        
                           Description:A proper value is applicable, but not known.
            <br/>

                        
                           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:
            <br/>

                        
                           Those properties themselves directly translate to a semantic
               of &quot;unknown&quot;.  (E.g. a local code sent as a translation that conveys 'unknown')
                           Those properties further qualify the nature of what is unknown.
                (E.g. specifying a use code of &quot;H&quot; and a URL prefix of &quot;tel:&quot; to
               convey that it is the home phone number that is unknown.)
                        
                     
          </td>
        </tr>
 
        <tr>
          <td>3</td>
          <td>    ASKU
            <a name="ASKU"> </a>
          </td>
          <td>asked but unknown</td>
          <td>
                        Information was sought but not found (e.g. patient was asked but
               didn't know)
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>4</td>
          <td>      NAV
            <a name="NAV"> </a>
          </td>
          <td>temporarily unavailable</td>
          <td>
                        Information is not available at this time but it is expected that
               it will be available later.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>3</td>
          <td>    NASK
            <a name="NASK"> </a>
          </td>
          <td>not asked</td>
          <td>
                        This information has not been sought (e.g. patient was not asked)
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>3</td>
          <td>    QS
            <a name="QS"> </a>
          </td>
          <td>Sufficient Quantity</td>
          <td>
                        
                           Description:The specific quantity is not known, but is known
               to be non-zero and is not specified because it makes up the bulk of the material; e.g.
               'Add 10mg of ingredient X, 50mg of ingredient Y, and sufficient quantity of water to 100mL.'
               The null flavor would be used to express the quantity of water.
            <br/>

                     
          </td>
        </tr>
 
        <tr>
          <td>3</td>
          <td>    TRC
            <a name="TRC"> </a>
          </td>
          <td>trace</td>
          <td>
                        The content is greater than zero, but too small to be quantified.
            <br/>

                     
          </td>
        </tr>
 
        <tr style="background: #EFEFEF">
          <td>1</td>
          <td>NP
            <a name="NP"> </a> 
            <b>
              <i>Deprecated</i>
            </b>
          </td>
          <td>not present</td>
          <td>
                        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.
            <br/>

                     
          </td>
        </tr>

      </table>

    </div>
  </text>
  <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid">
    <valueUri value="urn:oid:2.16.840.1.113883.1.11.10609"/>
  </extension>
  <url value="http://hl7.org/fhir/ValueSet/v3-NullFlavor"/>
  <version value="2015-07-31"/>
  <name value="v3 Code System NullFlavor"/>
  <status value="active"/>
  <experimental value="false"/>
  <publisher value="HL7, Inc"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org"/>
    </telecom>
  </contact>
  <date value="2015-07-31"/>
  <description value=" A collection of codes specifying why a valid value is not present."/>
  <codeSystem>
    <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid">
      <valueUri value="urn:oid:2.16.840.1.113883.5.1008"/>
    </extension>
    <system value="http://hl7.org/fhir/v3/NullFlavor"/>
    <caseSensitive value="true"/>
    <concept>
      <code value="NI"/>
      <abstract value="false"/>
      <display value="NoInformation"/>
      <definition value="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."/>
      <concept>
        <code value="INV"/>
        <abstract value="false"/>
        <display value="invalid"/>
        <definition value="Description:The value as represented in the instance is not a member of the set of permitted
           data values in the constrained value domain of a variable."/>
        <concept>
          <code value="DER"/>
          <abstract value="false"/>
          <display value="derived"/>
          <definition value="Description:An actual value may exist, but it must be derived from the provided information
             (usually an EXPR generic data type extension will be used to convey the derivation expressionexpress
            ion ."/>
        </concept>
        <concept>
          <code value="OTH"/>
          <abstract value="false"/>
          <display value="other"/>
          <definition value="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."/>
          <concept>
            <code value="NINF"/>
            <abstract value="false"/>
            <display value="negative infinity"/>
            <definition value="Negative infinity of numbers."/>
          </concept>
          <concept>
            <code value="PINF"/>
            <abstract value="false"/>
            <display value="positive infinity"/>
            <definition value="Positive infinity of numbers."/>
          </concept>
        </concept>
        <concept>
          <code value="UNC"/>
          <abstract value="false"/>
          <display value="un-encoded"/>
          <definition value="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."/>
        </concept>
      </concept>
      <concept>
        <code value="MSK"/>
        <abstract value="false"/>
        <display value="masked"/>
        <definition value="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."/>
      </concept>
      <concept>
        <code value="NA"/>
        <abstract value="false"/>
        <display value="not applicable"/>
        <definition value="Known to have no proper value (e.g. last menstrual period for a male)."/>
      </concept>
      <concept>
        <code value="UNK"/>
        <abstract value="false"/>
        <display value="unknown"/>
        <definition value="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:                         
                                       Those properties themselves directly translate to a semantic
           of &quot;unknown&quot;.  (E.g. a local code sent as a translation that conveys 'unknown')
                                      Those properties further qualify the nature of what is unknown.
            (E.g. specifying a use code of &quot;H&quot; and a URL prefix of &quot;tel:&quot; to
           convey that it is the home phone number that is unknown.)"/>
        <concept>
          <code value="ASKU"/>
          <abstract value="false"/>
          <display value="asked but unknown"/>
          <definition value="Information was sought but not found (e.g. patient was asked but didn't know)"/>
          <concept>
            <code value="NAV"/>
            <abstract value="false"/>
            <display value="temporarily unavailable"/>
            <definition value="Information is not available at this time but it is expected that it will be available
               later."/>
          </concept>
        </concept>
        <concept>
          <code value="NASK"/>
          <abstract value="false"/>
          <display value="not asked"/>
          <definition value="This information has not been sought (e.g. patient was not asked)"/>
        </concept>
        <concept>
          <code value="QS"/>
          <abstract value="false"/>
          <display value="Sufficient Quantity"/>
          <definition value="Description:The specific quantity is not known, but is known to be non-zero and is not
             specified because it makes up the bulk of the material; e.g. 'Add 10mg of ingredient X,
             50mg of ingredient Y, and sufficient quantity of water to 100mL.' The null flavor would
             be used to express the quantity of water."/>
        </concept>
        <concept>
          <code value="TRC"/>
          <abstract value="false"/>
          <display value="trace"/>
          <definition value="The content is greater than zero, but too small to be quantified."/>
        </concept>
      </concept>
    </concept>
    <concept>
      <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated">
        <valueBoolean value="true"/>
      </extension>
      <code value="NP"/>
      <abstract value="false"/>
      <display value="not present"/>
      <definition value="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."/>
    </concept>
  </codeSystem>
</ValueSet>