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

Example CodeSystem/medicationrequest-status (XML)

Pharmacy Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemMedicationRequest Status Codes

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="medicationrequest-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://hl7.org/fhir/CodeSystem/medicationrequest-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">active
            <a name="medicationrequest-status-active"> </a> 
          </td> 
          <td> Active</td> 
          <td> The request is 'actionable', but not all actions that are implied by it have occurred
             yet.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">on-hold
            <a name="medicationrequest-status-on-hold"> </a> 
          </td> 
          <td> On Hold</td> 
          <td> Actions implied by the request are to be temporarily halted. The request might or might
             not be resumed. May also be called 'suspended'.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">ended
            <a name="medicationrequest-status-ended"> </a> 
          </td> 
          <td> Ended</td> 
          <td> The request is no longer active and the subject should no longer be taking the medication.</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  stopped
            <a name="medicationrequest-status-stopped"> </a> 
          </td> 
          <td> Stopped</td> 
          <td> Actions implied by the request are to be permanently halted, before all of the administrations
             occurred. This should not be used if the original order was entered in error</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  completed
            <a name="medicationrequest-status-completed"> </a> 
          </td> 
          <td> Completed</td> 
          <td> All actions that are implied by the request have occurred.</td> 
        </tr> 
        <tr> 
          <td> 2</td> 
          <td style="white-space:nowrap">  cancelled
            <a name="medicationrequest-status-cancelled"> </a> 
          </td> 
          <td> Cancelled</td> 
          <td> The request has been withdrawn before any administrations have occurred</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">entered-in-error
            <a name="medicationrequest-status-entered-in-error"> </a> 
          </td> 
          <td> Entered in Error</td> 
          <td> The request was recorded against the wrong patient or for some reason should not have
             been recorded (e.g. wrong medication, wrong dose, etc). Some of the actions that are implied
             by the medication request may have occurred. For example, the medication may have been
             dispensed and the patient may have taken some of the medication.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">draft
            <a name="medicationrequest-status-draft"> </a> 
          </td> 
          <td> Draft</td> 
          <td> The request is not yet 'actionable', e.g. it is a work in progress, requires sign-off,
             verification or needs to be run through decision support process.</td> 
        </tr> 
        <tr> 
          <td> 1</td> 
          <td style="white-space:nowrap">unknown
            <a name="medicationrequest-status-unknown"> </a> 
          </td> 
          <td> Unknown</td> 
          <td> The authoring/source system does not know which of the status values currently applies
             for this request. Note: This concept is not to be used for 'other' - 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="phx"/> 
  </extension> 
  <url value="http://hl7.org/fhir/CodeSystem/medicationrequest-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.1377"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="MedicationRequest Status Codes"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/medicationrequest-status"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <concept> 
    <code value="active"/> 
    <display value="Active"/> 
    <definition value="The request is 'actionable', but not all actions that are implied by it have occurred
     yet."/> 
  </concept> 
  <concept> 
    <code value="on-hold"/> 
    <display value="On Hold"/> 
    <definition value="Actions implied by the request are to be temporarily halted. The request might or might
     not be resumed. May also be called 'suspended'."/> 
  </concept> 
  <concept> 
    <code value="ended"/> 
    <display value="Ended"/> 
    <definition value="The request is no longer active and the subject should no longer be taking the medication."/> 
    <concept> 
      <code value="stopped"/> 
      <display value="Stopped"/> 
      <definition value="Actions implied by the request are to be permanently halted, before all of the administrations
       occurred. This should not be used if the original order was entered in error"/> 
    </concept> 
    <concept> 
      <code value="completed"/> 
      <display value="Completed"/> 
      <definition value="All actions that are implied by the request have occurred."/> 
    </concept> 
    <concept> 
      <code value="cancelled"/> 
      <display value="Cancelled"/> 
      <definition value="The request has been withdrawn before any administrations have occurred"/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="entered-in-error"/> 
    <display value="Entered in Error"/> 
    <definition value="The request was recorded against the wrong patient or for some reason should not have
     been recorded (e.g. wrong medication, wrong dose, etc). Some of the actions that are implied
     by the medication request may have occurred. For example, the medication may have been
     dispensed and the patient may have taken some of the medication."/> 
  </concept> 
  <concept> 
    <code value="draft"/> 
    <display value="Draft"/> 
    <definition value="The request is not yet 'actionable', e.g. it is a work in progress, requires sign-off,
     verification or needs to be run through decision support process."/> 
  </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 request. Note: This concept is not to be used for 'other' - 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.