Clinical Document Architecture
2.0.0-sd-ballot - ballot

This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd-ballot: CDA 2.0 Ballot 1) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

: CDANullFlavor - JSON Representation

Draft as of 2023-10-27

Raw json | Download


{
  "resourceType" : "ValueSet",
  "id" : "CDANullFlavor",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>Include these codes as defined in <a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html\"><code>http://terminology.hl7.org/CodeSystem/v3-NullFlavor</code></a> version <code>2.1.0</code><table class=\"none\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-NP\">NP</a></td><td style=\"color: #cccccc\">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.</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-NI\">NI</a></td><td style=\"color: #cccccc\">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.</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-MSK\">MSK</a></td><td style=\"color: #cccccc\">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/><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.</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-NA\">NA</a></td><td style=\"color: #cccccc\">not applicable</td><td>Known to have no proper value (e.g., last menstrual period for a male).</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-OTH\">OTH</a></td><td style=\"color: #cccccc\">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/><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/><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.</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-NINF\">NINF</a></td><td style=\"color: #cccccc\">negative infinity</td><td>Negative infinity of numbers.</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-PINF\">PINF</a></td><td style=\"color: #cccccc\">positive infinity</td><td>Positive infinity of numbers.</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-UNK\">UNK</a></td><td style=\"color: #cccccc\">unknown</td><td>**Description:**A proper value is applicable, but not known.<br/><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/><br/>1.  Those properties themselves directly translate to a semantic of &quot;unknown&quot;. (E.g. a local code sent as a translation that conveys 'unknown')<br/>2.  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><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-NASK\">NASK</a></td><td style=\"color: #cccccc\">not asked</td><td>This information has not been sought (e.g., patient was not asked)</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-TRC\">TRC</a></td><td style=\"color: #cccccc\">trace</td><td>The content is greater than zero, but too small to be quantified.</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-ASKU\">ASKU</a></td><td style=\"color: #cccccc\">asked but unknown</td><td>Information was sought but not found (e.g., patient was asked but didn't know)</td></tr><tr><td><a href=\"http://terminology.hl7.org/5.2.0/CodeSystem-v3-NullFlavor.html#v3-NullFlavor-NAV\">NAV</a></td><td style=\"color: #cccccc\">temporarily unavailable</td><td>Information is not available at this time but it is expected that it will be available later.</td></tr></table></li></ul></div>"
  },
  "url" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor",
  "version" : "2.0.0-sd-ballot",
  "name" : "CDANullFlavor",
  "title" : "CDANullFlavor",
  "status" : "draft",
  "experimental" : false,
  "date" : "2023-10-27T07:17:32+11:00",
  "publisher" : "Health Level 7",
  "contact" : [
    {
      "name" : "HL7 International - Structured Documents",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/structure"
        },
        {
          "system" : "email",
          "value" : "structdog@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "CDA NullFlavors - limited to values allowed in original CDA definition",
  "compose" : {
    "include" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
        "version" : "2.1.0",
        "concept" : [
          {
            "code" : "NP"
          },
          {
            "code" : "NI"
          },
          {
            "code" : "MSK"
          },
          {
            "code" : "NA"
          },
          {
            "code" : "OTH"
          },
          {
            "code" : "NINF"
          },
          {
            "code" : "PINF"
          },
          {
            "code" : "UNK"
          },
          {
            "code" : "NASK"
          },
          {
            "code" : "TRC"
          },
          {
            "code" : "ASKU"
          },
          {
            "code" : "NAV"
          }
        ]
      }
    ]
  }
}