R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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: R4 R3

V2-0119.vs.xml

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

Raw XML (canonical form)

FHIR Value set/code system definition for HL7 v2 table 0119 ( Order Control Codes)

<ValueSet xmlns="http://hl7.org/fhir">
  <id value="v2-0119"/> 
  <meta> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablevalueset"/> 
  </meta> 
  <text> 
    <status value="additional"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> Order Control Codes</p> 

      <table class="grid">
        <tr> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> Description</b> 
          </td> 
          <td> 
            <b> Comment</b> 
          </td> 
          <td> 
            <b> Version</b> 
          </td> 
        </tr> 
        <tr> 
          <td> AF
            <a name="AF"> </a> 
          </td> 
          <td> Order/service refill request approval</td> 
          <td> Placer Applications.&lt;p&gt;AF is a response to RF where the placer authorizing a refill
               or quantity of refills.</td> 
          <td> added v2.3</td> 
        </tr> 
        <tr> 
          <td> CA
            <a name="CA"> </a> 
          </td> 
          <td> Cancel order/service request</td> 
          <td> Placer or Filler Applications.&lt;p&gt;A cancellation is a request by the placer for the
               filler, or the filler to the placer, not to do a previously ordered service. Confirmation
               of the cancellation request is provided by the filler or placer, e.g. a message w</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> CH
            <a name="CH"> </a> 
          </td> 
          <td> Child order/service</td> 
          <td> Placer or Filler Applications.&lt;p&gt;Used in conjunction with the PA - Parent order
               control code. Refer to PA order control code for discussion.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> CN
            <a name="CN"> </a> 
          </td> 
          <td> Combined result</td> 
          <td> Filler Applications.&lt;p&gt;The combined result code provides a mechanism to transmit
               results that are associated with two or more orders. This situation occurs commonly in
               radiology reports when the radiologist dictates a single report for two or more exams
               r</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> CP
            <a name="CP"> </a> 
          </td> 
          <td> Cancel process step</td> 
          <td> Filler Applications.&lt;p&gt;The control code CP - Cancel process step should be used
               in the ORC-1 for communication Filler-to-Filler, e.g. LIS-to-Analyzer, to differentiate
               from code CA (Placer-to-Filler).&lt;p&gt;The Filler should response with an acceptance
               of th</td> 
          <td> added v2.8</td> 
        </tr> 
        <tr> 
          <td> CR
            <a name="CR"> </a> 
          </td> 
          <td> Canceled as requested</td> 
          <td> Filler or Placer Applications.&lt;p&gt;A response by the filler or placer application
               that a request to cancel (CA by the placer application) was performed successfully.</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> DC
            <a name="DC"> </a> 
          </td> 
          <td> Discontinue order/service request</td> 
          <td> Placer or Filler Applications.&lt;p&gt;A request by the placer for the filler, or the
               filler to the placer,  to discontinue a previously requested service. The differentiation
               between discontinue and cancel is that discontinue effects the order/service and all </td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> DE
            <a name="DE"> </a> 
          </td> 
          <td> Data errors</td> 
          <td> Placer or Filler Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> DF
            <a name="DF"> </a> 
          </td> 
          <td> Order/service refill request denied</td> 
          <td> Placer Applications.&lt;p&gt;In response to a Filler application requesting refill authorization
               (RF), DF indicates that the placer does not authorize refills for the order. ORC-16 Order
               Control Code reason may be used to indicate the reason for the request den</td> 
          <td> added v2.3</td> 
        </tr> 
        <tr> 
          <td> DR
            <a name="DR"> </a> 
          </td> 
          <td> Discontinued as requested</td> 
          <td> Filler or Placer Applications.&lt;p&gt;The filler or placer, in response to a request
               to discontinue (DC from the placer or filler application), has discontinued the order/service.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> FU
            <a name="FU"> </a> 
          </td> 
          <td> Order/service refilled, unsolicited</td> 
          <td> Filler Applications.&lt;p&gt;FU notifies the placer that the filler issued a refill for
               the order at the patient's request.</td> 
          <td> added v2.3</td> 
        </tr> 
        <tr> 
          <td> HD
            <a name="HD"> </a> 
          </td> 
          <td> Hold order request</td> 
          <td> Placer Applications.&lt;p&gt;Typical responses include, but are not limited to, CR - Cancelled
               as requested, UC - Unable to Cancel.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> HR
            <a name="HR"> </a> 
          </td> 
          <td> On hold as requested</td> 
          <td> Filler Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> LI
            <a name="LI"> </a> 
          </td> 
          <td> Link order/service to patient care problem or goal</td> 
          <td> Placer or Filler Applications.&lt;p&gt;Refer to Chapter 12 Patient Care for complete discussion.</td> 
          <td> added v2.3.1</td> 
        </tr> 
        <tr> 
          <td> MC
            <a name="MC"> </a> 
          </td> 
          <td> Miscellaneous Charge - not associated with an order</td> 
          <td> applies to DFT^P03^DFT_P03 and DFT^P11^DFT_P11</td> 
          <td> added v2.6</td> 
        </tr> 
        <tr> 
          <td> NA
            <a name="NA"> </a> 
          </td> 
          <td> Number assigned</td> 
          <td> Placer Applications.&lt;p&gt;There are three circumstances that involve requesting an
               order number (ORC-2-placer order number or ORC-3-filler order number):&lt;p&gt;(1) When
               the filler application needs to request an ORC-3-filler order number from a centralized
               appli</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> NW
            <a name="NW"> </a> 
          </td> 
          <td> New order/service</td> 
          <td> Placer Applications.&lt;p&gt;See comments for NA - Number Assigned.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> OC
            <a name="OC"> </a> 
          </td> 
          <td> Order/service canceled</td> 
          <td> Filler Applications.</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> OD
            <a name="OD"> </a> 
          </td> 
          <td> Order/service discontinued</td> 
          <td> Filler Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> OE
            <a name="OE"> </a> 
          </td> 
          <td> Order/service released</td> 
          <td> Filler Applications.</td> 
          <td> added v2.3</td> 
        </tr> 
        <tr> 
          <td> OF
            <a name="OF"> </a> 
          </td> 
          <td> Order/service refilled as requested</td> 
          <td> Filler Applications.&lt;p&gt;OF directly responds to the placer system's request for a
               refill.</td> 
          <td> added v2.3</td> 
        </tr> 
        <tr> 
          <td> OH
            <a name="OH"> </a> 
          </td> 
          <td> Order/service held</td> 
          <td> Filler Applications.</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> OK
            <a name="OK"> </a> 
          </td> 
          <td> Order/service accepted &amp; OK</td> 
          <td> Filler Applications.&lt;p&gt;See comments for NA - Number Assigned.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> OP
            <a name="OP"> </a> 
          </td> 
          <td> Notification of order for outside dispense</td> 
          <td> Placer Applications.&lt;p&gt;These order control codes are used to communicate an order
               between systems where the order is intended for informational purposes. For example, an
               order that will be performed by a vendor outside the enterprise of communicating syst</td> 
          <td> added v2.5</td> 
        </tr> 
        <tr> 
          <td> OR
            <a name="OR"> </a> 
          </td> 
          <td> Released as requested</td> 
          <td> Filler Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> PA
            <a name="PA"> </a> 
          </td> 
          <td> Parent order/service</td> 
          <td> Filler Applications.&lt;p&gt;The parent (PA) and child (CH) order control codes allow
               the spawning of &quot;child&quot; orders from a &quot;parent&quot; order without changing
               the parent (original order). One or more ORC segments with an ORC-1-order control value
               of PA are followe</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> PR
            <a name="PR"> </a> 
          </td> 
          <td> Previous Results with new order/service</td> 
          <td> Placer Applications.&lt;p&gt;PR indicates that this ORC is part of an ORU structure containing
               previous observation, which is embedded in the order.&lt;p&gt;At least two main use cases
               require that the complete results of the previous observations be transmitted with</td> 
          <td> added v2.4</td> 
        </tr> 
        <tr> 
          <td> PY
            <a name="PY"> </a> 
          </td> 
          <td> Notification of replacement order for outside dispense</td> 
          <td> Placer Applications.&lt;p&gt;See comments for OP - Notification of order for outside dispense.</td> 
          <td> added v2.5</td> 
        </tr> 
        <tr> 
          <td> RE
            <a name="RE"> </a> 
          </td> 
          <td> Observations/Performed Service to follow</td> 
          <td> Placer or Filler Applications.&lt;p&gt;The observations-to-follow code is used to transmit
               patient-specific information with an order. An order detail segment (e.g. OBR) can be
               followed by one or more observation segments (OBX). Any observation that can be tra</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> RF
            <a name="RF"> </a> 
          </td> 
          <td> Refill order/service request</td> 
          <td> Placer or Filler Applications.&lt;p&gt;RF accommodates requests by either the filler or
               the placer. The filler may be requesting refill authorization from the placer. A placer
               system may be requesting a refill to be done by the filler system.&lt;p&gt;Typical response</td> 
          <td> added v2.3</td> 
        </tr> 
        <tr> 
          <td> RL
            <a name="RL"> </a> 
          </td> 
          <td> Release previous hold</td> 
          <td> Placer Applications.</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> RO
            <a name="RO"> </a> 
          </td> 
          <td> Replacement order</td> 
          <td> Placer or Filler Applications.&lt;p&gt;A replacement is the substitution of one or more
               orders for one or more previously ordered services.&lt;p&gt;The replaced orders are treated
               as though they were canceled. If and when an ordered service can be replaced are local
               </td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> RP
            <a name="RP"> </a> 
          </td> 
          <td> Order/service replace request</td> 
          <td> Placer Applications.&lt;p&gt;A replacement is the substitution of one or more orders for
               one or more previously ordered services. See comment 1 on RO - Replacement Order for further
               discussion.&lt;p&gt;The order replace request code permits the order filler to replac</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> RQ
            <a name="RQ"> </a> 
          </td> 
          <td> Replaced as requested</td> 
          <td> Filler Applications.&lt;p&gt;A replacement is the substitution of one or more orders for
               one or more previously ordered services. See comment 1 on RO - Replacement Order for further
               discussion.&lt;p&gt;The order replace request code permits the order filler to replac</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> RR
            <a name="RR"> </a> 
          </td> 
          <td> Request received</td> 
          <td> Placer or Filler Applications.&lt;p&gt;Left in for backward compatibility. In the current
               version it is equivalent to an accept acknowledgment. The request-received code indicates
               that an order message has been received and will be processed later. The order ha</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> RU
            <a name="RU"> </a> 
          </td> 
          <td> Replaced unsolicited</td> 
          <td> Filler Applications.&lt;p&gt;A replacement is the substitution of one or more orders for
               one or more previously ordered services. See comment 1 on RO - Replacement Order for further
               discussion.&lt;p&gt;The unsolicited replacement code permits the filler application t</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> SC
            <a name="SC"> </a> 
          </td> 
          <td> Status changed</td> 
          <td> Placer or Filler Applications.</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> SN
            <a name="SN"> </a> 
          </td> 
          <td> Send order/service number</td> 
          <td> Placer Applications.&lt;p&gt;See comments for NA - Number Assigned.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> SR
            <a name="SR"> </a> 
          </td> 
          <td> Response to send order/service status request</td> 
          <td> Filler Applications.</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> SS
            <a name="SS"> </a> 
          </td> 
          <td> Send order/service status request</td> 
          <td> Placer Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> UA
            <a name="UA"> </a> 
          </td> 
          <td> Unable to accept order/service</td> 
          <td> Filler Applications.&lt;p&gt;An unable-to-accept code is used when a new order cannot
               be accepted by the filler. Possible reasons include requesting a prescription for a drug
               which the patient is allergic to or for an order which requires certain equipment reso</td> 
          <td> added v2.3</td> 
        </tr> 
        <tr> 
          <td> UC
            <a name="UC"> </a> 
          </td> 
          <td> Unable to cancel</td> 
          <td> Filler or Placer Applications.&lt;p&gt;An unable-to-cancel code is used when the ordered
               service is at a point that it cannot be canceled by the placer or filler or when local
               rules prevent cancellation by the filler. The use of this code is dependent on the va</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> UD
            <a name="UD"> </a> 
          </td> 
          <td> Unable to discontinue</td> 
          <td> Filler or Placer Applications.&lt;p&gt;An unable-to-discontinue code is used when the
               ordered service is at a point that it cannot be discontinued by the placer or filler or
               when local rules prevent discontinuance by the filler. The use of this code is dependen</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> UF
            <a name="UF"> </a> 
          </td> 
          <td> Unable to refill</td> 
          <td> Filler Applications.&lt;p&gt;Negative response to RF Refill order/service request, indicating
               that the receiving application was not able to complete the refill request.</td> 
          <td> added v2.3</td> 
        </tr> 
        <tr> 
          <td> UH
            <a name="UH"> </a> 
          </td> 
          <td> Unable to put on hold</td> 
          <td> Filler Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> UM
            <a name="UM"> </a> 
          </td> 
          <td> Unable to replace</td> 
          <td> Filler Applications.</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> UN
            <a name="UN"> </a> 
          </td> 
          <td> Unlink order/service from patient care problem or goal</td> 
          <td> Placer or Filler Applications.&lt;p&gt;Refer to Chapter 12 Patient Care for complete discussion.</td> 
          <td> added v2.3.1</td> 
        </tr> 
        <tr> 
          <td> UR
            <a name="UR"> </a> 
          </td> 
          <td> Unable to release</td> 
          <td> Filler Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> UX
            <a name="UX"> </a> 
          </td> 
          <td> Unable to change</td> 
          <td> Filler Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> XO
            <a name="XO"> </a> 
          </td> 
          <td> Change order/service request</td> 
          <td> Placer Applications.</td> 
          <td> added v2.2</td> 
        </tr> 
        <tr> 
          <td> XR
            <a name="XR"> </a> 
          </td> 
          <td> Changed as requested</td> 
          <td> Filler Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
        <tr> 
          <td> XX
            <a name="XX"> </a> 
          </td> 
          <td> Order/service changed, unsol.</td> 
          <td> Filler Applications.</td> 
          <td> from v2.1</td> 
        </tr> 
      </table> 

    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status">
    <valueString value="External"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/> 
  </extension> 
  <url value="http://hl7.org/fhir/ValueSet/v2-0119"/> 
  <version value="2.8.2"/> 
  <name value="v2 Order Control Codes"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="FHIR Value set/code system definition for HL7 v2 table 0119 ( Order Control Codes)"/> 
  <immutable value="true"/> 
  <compose> 
    <include> 
      <system value="http://hl7.org/fhir/v2/0119"/> 
    </include> 
  </compose> 
</ValueSet> 

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.