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

Example CodeSystem/devicedispense-status (XML)

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

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

Definition for Code SystemDeviceDispense Status Codes

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="devicedispense-status"/> 
  <meta> 
    <lastUpdated value="2022-09-07T10:58:29.429+10: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://terminology.hl7.org/CodeSystem/devicedispense-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="devicedispense-status-preparation"> </a> 
          </td> 
          <td> Preparation</td> 
          <td> The core event has not started yet, but some staging activities have begun (e.g. initial
             preparing of the device. Preparation stages may be tracked e.g. for planning, supply or
             billing purposes.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">in-progress
            <a name="devicedispense-status-in-progress"> </a> 
          </td> 
          <td> In Progress</td> 
          <td> The dispensed product is ready for pickup.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">cancelled
            <a name="devicedispense-status-cancelled"> </a> 
          </td> 
          <td> Cancelled</td> 
          <td> The dispensed product was not and will never be picked up by the patient.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">on-hold
            <a name="devicedispense-status-on-hold"> </a> 
          </td> 
          <td> On Hold</td> 
          <td> The dispense process is paused while waiting for an external event to reactivate the dispense.
              For example, new stock has arrived or the prescriber has called.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">completed
            <a name="devicedispense-status-completed"> </a> 
          </td> 
          <td> Completed</td> 
          <td> The dispensed product has been picked up.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">entered-in-error
            <a name="devicedispense-status-entered-in-error"> </a> 
          </td> 
          <td> Entered in Error</td> 
          <td> The dispense was entered in error and therefore nullified.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">stopped
            <a name="devicedispense-status-stopped"> </a> 
          </td> 
          <td> Stopped</td> 
          <td> Actions implied by the dispense have been permanently halted, before all of them occurred.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">declined
            <a name="devicedispense-status-declined"> </a> 
          </td> 
          <td> Declined</td> 
          <td> The dispense was declined and not performed.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">unknown
            <a name="devicedispense-status-unknown"> </a> 
          </td> 
          <td> Unknown</td> 
          <td> The authoring system does not know which of the status values applies for this dispense.
              Note: this concept is not to be used for other - one of the listed statuses is presumed
             to apply, it's just now known which one.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="oo"/> 
  </extension> 
  <url value="http://terminology.hl7.org/CodeSystem/devicedispense-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.2020"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="DeviceDispense Status Codes"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/devicedispense-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. initial
     preparing of the device. Preparation stages may be tracked e.g. for planning, supply or
     billing purposes."/> 
  </concept> 
  <concept> 
    <code value="in-progress"/> 
    <display value="In Progress"/> 
    <definition value="The dispensed product is ready for pickup."/> 
  </concept> 
  <concept> 
    <code value="cancelled"/> 
    <display value="Cancelled"/> 
    <definition value="The dispensed product was not and will never be picked up by the patient."/> 
  </concept> 
  <concept> 
    <code value="on-hold"/> 
    <display value="On Hold"/> 
    <definition value="The dispense process is paused while waiting for an external event to reactivate the dispense.
      For example, new stock has arrived or the prescriber has called."/> 
  </concept> 
  <concept> 
    <code value="completed"/> 
    <display value="Completed"/> 
    <definition value="The dispensed product has been picked up."/> 
  </concept> 
  <concept> 
    <code value="entered-in-error"/> 
    <display value="Entered in Error"/> 
    <definition value="The dispense was entered in error and therefore nullified."/> 
  </concept> 
  <concept> 
    <code value="stopped"/> 
    <display value="Stopped"/> 
    <definition value="Actions implied by the dispense have been permanently halted, before all of them occurred."/> 
  </concept> 
  <concept> 
    <code value="declined"/> 
    <display value="Declined"/> 
    <definition value="The dispense was declined and not performed."/> 
  </concept> 
  <concept> 
    <code value="unknown"/> 
    <display value="Unknown"/> 
    <definition value="The authoring system does not know which of the status values applies for this dispense.
      Note: this concept is not to be used for other - one of the listed statuses is presumed
     to apply, it's just now known which one."/> 
  </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.