Release 5 Ballot

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

Example CodeSystem/medicationdispense-status (XML)

Pharmacy Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemMedication Dispense Status Codes

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="medicationdispense-status"/> 
  <meta> 
    <lastUpdated value="2022-09-10T04:52:37.223+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://hl7.org/fhir/CodeSystem/medicationdispense-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="medicationdispense-status-preparation"> </a> 
          </td> 
          <td> Preparation</td> 
          <td> The core event has not started yet, but some staging activities have begun (e.g.
             initial compounding or packaging of medication). Preparation stages may be tracked
             for billing purposes.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">in-progress
            <a name="medicationdispense-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="medicationdispense-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="medicationdispense-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="medicationdispense-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="medicationdispense-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="medicationdispense-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="medicationdispense-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="medicationdispense-status-unknown"> </a> 
          </td> 
          <td> Unknown</td> 
          <td> The authoring system does not know which of the status values applies for this
             medication 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="phx"/> 
  </extension> 
  <url value="http://hl7.org/fhir/CodeSystem/medicationdispense-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.1971"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="Medication Dispense Status Codes"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/medicationDispense-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 compounding or packaging of medication). Preparation stages may be tracked
     for 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
     medication 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.