Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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: R5 R4B R4 R3

Example CodeSystem/event-status (XML)

Patient Care Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemEventStatus

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="event-status"/> 
  <meta> 
    <lastUpdated value="2022-09-07T10:58:29.429+10:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system 
        <code> http://hl7.org/fhir/event-status</code>  defines the following codes:
      </p> 
      <table class="codes">
        <tr> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">preparation
            <a name="event-status-preparation"> </a> 
          </td> 
          <td> Preparation</td> 
          <td> The core event has not started yet, but some staging activities have begun (e.g. surgical
             suite preparation).  Preparation stages may be tracked for billing purposes.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">in-progress
            <a name="event-status-in-progress"> </a> 
          </td> 
          <td> In Progress</td> 
          <td> The event is currently occurring.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">not-done
            <a name="event-status-not-done"> </a> 
          </td> 
          <td> Not Done</td> 
          <td> The event was terminated prior to any activity beyond preparation.  I.e. The 'main' activity
             has not yet begun.  The boundary between preparatory and the 'main' activity is context-specific.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">on-hold
            <a name="event-status-on-hold"> </a> 
          </td> 
          <td> On Hold</td> 
          <td> The event has been temporarily stopped but is expected to resume in the future.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">stopped
            <a name="event-status-stopped"> </a> 
          </td> 
          <td> Stopped</td> 
          <td> The event was terminated prior to the full completion of the intended activity but after
             at least some of the 'main' activity (beyond preparation) has occurred.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">completed
            <a name="event-status-completed"> </a> 
          </td> 
          <td> Completed</td> 
          <td> The event has now concluded.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">entered-in-error
            <a name="event-status-entered-in-error"> </a> 
          </td> 
          <td> Entered in Error</td> 
          <td> 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;stopped&quot; rather than &quot;entered-in-error&quot;.).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">unknown
            <a name="event-status-unknown"> </a> 
          </td> 
          <td> Unknown</td> 
          <td> The authoring/source system does not know which of the status values currently applies
             for this event.  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="pc"/> 
  </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/event-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.110"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="EventStatus"/> 
  <title value="EventStatus"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <date value="2022-09-07T10:58:29+10: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 identifying the lifecycle stage of an event."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/event-status"/> 
  <content value="complete"/> 
  <concept> 
    <code value="preparation"/> 
    <display value="Preparation"/> 
    <definition value="The core event has not started yet, but some staging activities have begun (e.g. surgical
     suite preparation).  Preparation stages may be tracked for billing purposes."/> 
  </concept> 
  <concept> 
    <code value="in-progress"/> 
    <display value="In Progress"/> 
    <definition value="The event is currently occurring."/> 
  </concept> 
  <concept> 
    <code value="not-done"/> 
    <display value="Not Done"/> 
    <definition value="The event was terminated prior to any activity beyond preparation.  I.e. The 'main' activity
     has not yet begun.  The boundary between preparatory and the 'main' activity is context-specific."/> 
  </concept> 
  <concept> 
    <code value="on-hold"/> 
    <display value="On Hold"/> 
    <definition value="The event has been temporarily stopped but is expected to resume in the future."/> 
  </concept> 
  <concept> 
    <code value="stopped"/> 
    <display value="Stopped"/> 
    <definition value="The event was terminated prior to the full completion of the intended activity but after
     at least some of the 'main' activity (beyond preparation) has occurred."/> 
  </concept> 
  <concept> 
    <code value="completed"/> 
    <display value="Completed"/> 
    <definition value="The event has now concluded."/> 
  </concept> 
  <concept> 
    <code value="entered-in-error"/> 
    <display value="Entered in Error"/> 
    <definition value="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;stopped&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 event.  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.