Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/composition-status (XML)

Structured Documents Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemCompositionStatus

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="composition-status"/> 
  <meta> 
    <lastUpdated value="2023-03-26T15:21:02.749+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 code system 
        <code> http://hl7.org/fhir/composition-status</code>  defines the following codes:
      </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="composition-status-registered"> </a> 
          </td> 
          <td> Registered</td> 
          <td> The existence of the composition is registered, but there is nothing yet available.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">partial
            <a name="composition-status-partial"> </a> 
          </td> 
          <td> Partial</td> 
          <td> This is a partial (e.g. initial, interim or preliminary) composition: data in the
             composition may be incomplete or unverified.</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  preliminary
            <a name="composition-status-preliminary"> </a> 
          </td> 
          <td> Preliminary</td> 
          <td> Verified early results are available, but not all results are final.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">final
            <a name="composition-status-final"> </a> 
          </td> 
          <td> Final</td> 
          <td> This version of the composition is complete and verified by an appropriate person
             and no further work is planned. Any subsequent updates would be on a new version
             of the composition.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">amended
            <a name="composition-status-amended"> </a> 
          </td> 
          <td> Amended</td> 
          <td> The composition content or the referenced resources have been modified (edited
             or added to) subsequent to being released as &quot;final&quot; and the composition
             is complete and verified by an authorized person.</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  corrected
            <a name="composition-status-corrected"> </a> 
          </td> 
          <td> Corrected</td> 
          <td> Subsequent to being final, the composition content has been modified to correct
             an error in the composition or referenced results.</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  appended
            <a name="composition-status-appended"> </a> 
          </td> 
          <td> Appended</td> 
          <td> Subsequent to being final, the composition content has been modified by adding
             new content. The existing content is unchanged.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">cancelled
            <a name="composition-status-cancelled"> </a> 
          </td> 
          <td> Cancelled</td> 
          <td> The composition is unavailable because the measurement was not started or not completed
             (also sometimes called &quot;aborted&quot;).</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">entered-in-error
            <a name="composition-status-entered-in-error"> </a> 
          </td> 
          <td> Entered in Error</td> 
          <td> The composition or document was originally created/issued in error, and this is
             an amendment that marks that the entire series should not be considered as valid.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">deprecated
            <a name="composition-status-deprecated"> </a> 
          </td> 
          <td> Deprecated</td> 
          <td> This composition has been withdrawn or superseded and should no longer be used.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">unknown
            <a name="composition-status-unknown"> </a> 
          </td> 
          <td> Unknown</td> 
          <td> 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.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="sd"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3"/> 
  </extension> 
  <url value="http://hl7.org/fhir/composition-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.242"/> 
  </identifier> 
  <identifier> 
    <use value="old"/> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.237"/> 
  </identifier> 
  <identifier> 
    <use value="old"/> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.2.123"/> 
  </identifier> 
  <version value="5.0.0"/> 
  <name value="CompositionStatus"/> 
  <title value="Composition 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="The workflow/clinical status of the composition."/> 
  <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/composition-status"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <concept> 
    <code value="registered"/> 
    <display value="Registered"/> 
    <definition value="The existence of the composition is registered, but there is nothing yet available."/> 
  </concept> 
  <concept> 
    <code value="partial"/> 
    <display value="Partial"/> 
    <definition value="This is a partial (e.g. initial, interim or preliminary) composition: data in the
     composition may be incomplete or unverified."/> 
    <concept> 
      <code value="preliminary"/> 
      <display value="Preliminary"/> 
      <definition value="Verified early results are available, but not all results are final."/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="final"/> 
    <display value="Final"/> 
    <definition value="This version of the composition is complete and verified by an appropriate person
     and no further work is planned. Any subsequent updates would be on a new version
     of the composition."/> 
  </concept> 
  <concept> 
    <code value="amended"/> 
    <display value="Amended"/> 
    <definition value="The composition content or the referenced resources have been modified (edited
     or added to) subsequent to being released as &quot;final&quot; and the composition
     is complete and verified by an authorized person."/> 
    <concept> 
      <code value="corrected"/> 
      <display value="Corrected"/> 
      <definition value="Subsequent to being final, the composition content has been modified to correct
       an error in the composition or referenced results."/> 
    </concept> 
    <concept> 
      <code value="appended"/> 
      <display value="Appended"/> 
      <definition value="Subsequent to being final, the composition content has been modified by adding
       new content. The existing content is unchanged."/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="cancelled"/> 
    <display value="Cancelled"/> 
    <definition value="The composition 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 composition or document was originally created/issued in error, and this is
     an amendment that marks that the entire series should not be considered as valid."/> 
  </concept> 
  <concept> 
    <code value="deprecated"/> 
    <display value="Deprecated"/> 
    <definition value="This composition has been withdrawn or superseded and should no longer be used."/> 
  </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.