Null-flavor.xml

Definition for Value SetNullFlavor

Raw XML

<ValueSet xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>NullFlavor</h2>
      <p>A collection of codes specifying why a valid value is not present</p>
      <p>This value set includes codes defined in other code systems, using the following rules:</p>
      <ul>
        <li>Include these codes as defined in 
          <a href="http://hl7.org/fhir/v3/NullFlavor">http://hl7.org/fhir/v3/NullFlavor</a>
          <table>
            <tr>
              <td>
                <b>Code</b>
              </td>
              <td>
                <b>Display</b>
              </td>
              <td>
                <b>Definition</b>
              </td>
            </tr>
            <tr>
              <td>NI</td>
              <td>NoInformation</td>
              <td>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.</td>
            </tr>
            <tr>
              <td>INV</td>
              <td>invalid</td>
              <td>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.</td>
            </tr>
            <tr>
              <td>DER</td>
              <td>derived</td>
              <td>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 expression.</td>
            </tr>
            <tr>
              <td>OTH</td>
              <td>other</td>
              <td>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.</td>
            </tr>
            <tr>
              <td>NINF</td>
              <td>negative infinity</td>
              <td>Negative infinity of numbers.</td>
            </tr>
            <tr>
              <td>PINF</td>
              <td>positive infinity</td>
              <td>Positive infinity of numbers.</td>
            </tr>
            <tr>
              <td>UNC</td>
              <td>un-encoded</td>
              <td>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.</td>
            </tr>
            <tr>
              <td>MSK</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. 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.</td>
            </tr>
            <tr>
              <td>NA</td>
              <td>not applicable</td>
              <td>Known to have no proper value (e.g., last menstrual period for a male).</td>
            </tr>
            <tr>
              <td>UNK</td>
              <td>unknown</td>
              <td>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.</td>
            </tr>
            <tr>
              <td>ASKU</td>
              <td>asked but unknown</td>
              <td>Information was sought but not found (e.g., patient was asked but didn't know).</td>
            </tr>
            <tr>
              <td>NAV</td>
              <td>temporarily unavailable</td>
              <td>Information is not available at this time but it is expected that it will be available
                 later.</td>
            </tr>
            <tr>
              <td>NASK</td>
              <td>not asked</td>
              <td>This information has not been sought (e.g., patient was not asked).</td>
            </tr>
            <tr>
              <td>QS</td>
              <td>Sufficient Quantity</td>
              <td>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.</td>
            </tr>
            <tr>
              <td>TRC</td>
              <td>trace</td>
              <td>The content is greater than zero, but too small to be quantified.</td>
            </tr>
          </table>
        </li>
      </ul>
    </div>
  </text>
  <identifier value="http://hl7.org/fhir/vs/null-flavor"/>
  <name value="NullFlavor"/>
  <publisher value="HL7 (FHIR Project)"/>
  <telecom>
    <system value="url"/>
    <value value="http://hl7.org/fhir"/>
  </telecom>
  <telecom>
    <system value="email"/>
    <value value="fhir@lists.hl7.org"/>
  </telecom>
  <description value="A collection of codes specifying why a valid value is not present"/>
  <status value="draft"/>
  <date value="2014-09-30T18:09:16.975+10:00"/>
  <compose>
    <include>
      <system value="http://hl7.org/fhir/v3/NullFlavor"/>
      <code value="NI">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="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."/>
        </extension>
      </code>
      <code value="INV">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="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."/>
        </extension>
      </code>
      <code value="DER">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="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 expression."/>
        </extension>
      </code>
      <code value="OTH">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="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."/>
        </extension>
      </code>
      <code value="NINF">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="Negative infinity of numbers."/>
        </extension>
      </code>
      <code value="PINF">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="Positive infinity of numbers."/>
        </extension>
      </code>
      <code value="UNC">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="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."/>
        </extension>
      </code>
      <code value="MSK">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString 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."/>
        </extension>
      </code>
      <code value="NA">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="Known to have no proper value (e.g., last menstrual period for a male)."/>
        </extension>
      </code>
      <code value="UNK">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="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."/>
        </extension>
      </code>
      <code value="ASKU">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="Information was sought but not found (e.g., patient was asked but didn't know)."/>
        </extension>
      </code>
      <code value="NAV">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="Information is not available at this time but it is expected that it will be available
           later."/>
        </extension>
      </code>
      <code value="NASK">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="This information has not been sought (e.g., patient was not asked)."/>
        </extension>
      </code>
      <code value="QS">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="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."/>
        </extension>
      </code>
      <code value="TRC">
        <extension url="http://hl7.org/fhir/Profile/tools-extensions#definition">
          <valueString value="The content is greater than zero, but too small to be quantified."/>
        </extension>
      </code>
    </include>
  </compose>
</ValueSet>