2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3 R2

V3-NullFlavor.xml

Raw XML (canonical form)

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

Raw XML

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="v3-NullFlavor"/>
  <meta>
    <lastUpdated value="2014-12-11T00:00:00.000+11:00"/>
    <profile value="http://hl7.org/fhir/Profile/valueset-shareable-definition"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <extension url="http://hl7.org/fhir/ExtensionDefinition/valueset-oid">
    <valueUri value="urn:oid:2.16.840.1.113883.1.11.10609"/>
  </extension>
  <url value="http://hl7.org/fhir/v3/vs/NullFlavor"/>
  <version value="2014-12-11"/>
  <name value="v3 Code System NullFlavor"/>
  <publisher value="HL7, Inc"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org"/>
    </telecom>
  </contact>
  <description value=" A collection of codes specifying why a valid value is not present."/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2014-12-11"/>
  <define>
    <extension url="http://hl7.org/fhir/ExtensionDefinition/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>
  </define>
</ValueSet>

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.