R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example CodeSystem/observation-status (XML)

Orders and Observations Work GroupMaturity Level: N/AStandards Status: Informative

Raw XML (canonical form + also see XML Format Specification)

Definition for Code SystemObservationStatus

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="observation-status"/> 
  <meta> 
    <lastUpdated value="2023-12-18T15:12:07.602+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This case-sensitive code system 
        <code> http://hl7.org/fhir/observation-status</code>  defines the following codes in a Is-A heirarchy:
      </p> 
      <table class="codes">
        <tr> 
          <td> 
            <b> Lvl</b> 
          </td> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">registered
            <a name="observation-status-registered"> </a> 
          </td> 
          <td> Registered</td> 
          <td> 
            <div> 
              <p> The existence of the observation is registered, but there is no result yet available.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">preliminary
            <a name="observation-status-preliminary"> </a> 
          </td> 
          <td> Preliminary</td> 
          <td> 
            <div> 
              <p> This is an initial or interim observation: data may be incomplete or unverified.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">final
            <a name="observation-status-final"> </a> 
          </td> 
          <td> Final</td> 
          <td> 
            <div> 
              <p> The observation is complete and there are no further actions needed. Additional
                 information such &quot;released&quot;, &quot;signed&quot;, etc. would be represented
                 using 
                <a href="provenance.html">Provenance</a>  which provides not only the act but also the actors and dates and other related
                 data. These act states would be associated with an observation status of 
                <code> preliminary</code>  until they are all completed and then a status of 
                <code> final</code>  would be applied.
              </p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">amended
            <a name="observation-status-amended"> </a> 
          </td> 
          <td> Amended</td> 
          <td> 
            <div> 
              <p> Subsequent to being Final, the observation has been modified subsequent.  This
                 includes updates/new information and corrections.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  corrected
            <a name="observation-status-corrected"> </a> 
          </td> 
          <td> Corrected</td> 
          <td> 
            <div> 
              <p> Subsequent to being Final, the observation has been modified to correct an error
                 in the test result.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">cancelled
            <a name="observation-status-cancelled"> </a> 
          </td> 
          <td> Cancelled</td> 
          <td> 
            <div> 
              <p> The observation is unavailable because the measurement was not started or not completed
                 (also sometimes called &quot;aborted&quot;).</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">entered-in-error
            <a name="observation-status-entered-in-error"> </a> 
          </td> 
          <td> Entered in Error</td> 
          <td> 
            <div> 
              <p> The observation has been withdrawn following previous final release.  This electronic
                 record should never have existed, though it is possible that real-world decisions
                 were based on it. (If real-world activity has occurred, the status should be &quot;cancelled&
                quot; rather than &quot;entered-in-error&quot;.).</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">unknown
            <a name="observation-status-unknown"> </a> 
          </td> 
          <td> Unknown</td> 
          <td> 
            <div> 
              <p> The authoring/source system does not know which of the status values currently
                 applies for this observation. Note: This concept is not to be used for &quot;other&quot;
                 - one of the listed statuses is presumed to apply, but the authoring/source system
                 does not know which.</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="oo"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <url value="http://hl7.org/fhir/observation-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.401"/> 
  </identifier> 
  <identifier> 
    <use value="old"/> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.388"/> 
  </identifier> 
  <identifier> 
    <use value="old"/> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.2.219"/> 
  </identifier> 
  <version value="6.0.0-ballot1"/> 
  <name value="ObservationStatus"/> 
  <title value="Observation Status"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2021-01-05T10:01:24+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="Codes providing the status of an observation."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/observation-status"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <concept> 
    <code value="registered"/> 
    <display value="Registered"/> 
    <definition value="The existence of the observation is registered, but there is no result yet available."/> 
  </concept> 
  <concept> 
    <code value="preliminary"/> 
    <display value="Preliminary"/> 
    <definition value="This is an initial or interim observation: data may be incomplete or unverified."/> 
  </concept> 
  <concept> 
    <code value="final"/> 
    <display value="Final"/> 
    <definition value="The observation is complete and there are no further actions needed. Additional
     information such &quot;released&quot;, &quot;signed&quot;, etc. would be represented
     using [Provenance](provenance.html) which provides not only the act but also the
     actors and dates and other related data. These act states would be associated with
     an observation status of `preliminary` until they are all completed and then a
     status of `final` would be applied."/> 
  </concept> 
  <concept> 
    <code value="amended"/> 
    <display value="Amended"/> 
    <definition value="Subsequent to being Final, the observation has been modified subsequent.  This
     includes updates/new information and corrections."/> 
    <concept> 
      <code value="corrected"/> 
      <display value="Corrected"/> 
      <definition value="Subsequent to being Final, the observation has been modified to correct an error
       in the test result."/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="cancelled"/> 
    <display value="Cancelled"/> 
    <definition value="The observation is unavailable because the measurement was not started or not completed
     (also sometimes called &quot;aborted&quot;)."/> 
  </concept> 
  <concept> 
    <code value="entered-in-error"/> 
    <display value="Entered in Error"/> 
    <definition value="The observation has been withdrawn following previous final release.  This electronic
     record should never have existed, though it is possible that real-world decisions
     were based on it. (If real-world activity has occurred, the status should be &quot;cancelled&
    quot; rather than &quot;entered-in-error&quot;.)."/> 
  </concept> 
  <concept> 
    <code value="unknown"/> 
    <display value="Unknown"/> 
    <definition value="The authoring/source system does not know which of the status values currently
     applies for this observation. Note: This concept is not to be used for &quot;other&quot;
     - one of the listed statuses is presumed to apply, but the authoring/source system
     does not know which."/> 
  </concept> 
</CodeSystem> 

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.