Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CodeSystem/request-status (XML)

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

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

Definition for Code SystemRequestStatus

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="request-status"/> 
  <meta> 
    <lastUpdated value="2023-03-26T15:21:02.749+11:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system 
        <code> http://hl7.org/fhir/request-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">draft
            <a name="request-status-draft"> </a> 
          </td> 
          <td> Draft</td> 
          <td> The request has been created but is not yet complete or ready for action.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">active
            <a name="request-status-active"> </a> 
          </td> 
          <td> Active</td> 
          <td> The request is in force and ready to be acted upon.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">on-hold
            <a name="request-status-on-hold"> </a> 
          </td> 
          <td> On Hold</td> 
          <td> The request (and any implicit authorization to act) has been temporarily withdrawn
             but is expected to resume in the future.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">revoked
            <a name="request-status-revoked"> </a> 
          </td> 
          <td> Revoked</td> 
          <td> The request (and any implicit authorization to act) has been terminated prior to
             the known full completion of the intended actions.  No further activity should
             occur.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">completed
            <a name="request-status-completed"> </a> 
          </td> 
          <td> Completed</td> 
          <td> The activity described by the request has been fully performed.  No further activity
             will occur.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">entered-in-error
            <a name="request-status-entered-in-error"> </a> 
          </td> 
          <td> Entered in Error</td> 
          <td> This request should never have existed and should be considered 'void'.  (It is
             possible that real-world decisions were based on it.  If real-world activity has
             occurred, the status should be &quot;revoked&quot; rather than &quot;entered-in-error&quot;.)
            .</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">unknown
            <a name="request-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 &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="4"/> 
  </extension> 
  <url value="http://hl7.org/fhir/request-status"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.112"/> 
  </identifier> 
  <version value="5.0.0"/> 
  <name value="RequestStatus"/> 
  <title value="RequestStatus"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <date value="2023-03-26T15:21:02+11: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 a request."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/request-status"/> 
  <content value="complete"/> 
  <concept> 
    <code value="draft"/> 
    <display value="Draft"/> 
    <definition value="The request has been created but is not yet complete or ready for action."/> 
  </concept> 
  <concept> 
    <code value="active"/> 
    <display value="Active"/> 
    <definition value="The request is in force and ready to be acted upon."/> 
  </concept> 
  <concept> 
    <code value="on-hold"/> 
    <display value="On Hold"/> 
    <definition value="The request (and any implicit authorization to act) has been temporarily withdrawn
     but is expected to resume in the future."/> 
  </concept> 
  <concept> 
    <code value="revoked"/> 
    <display value="Revoked"/> 
    <definition value="The request (and any implicit authorization to act) has been terminated prior to
     the known full completion of the intended actions.  No further activity should
     occur."/> 
  </concept> 
  <concept> 
    <code value="completed"/> 
    <display value="Completed"/> 
    <definition value="The activity described by the request has been fully performed.  No further activity
     will occur."/> 
  </concept> 
  <concept> 
    <code value="entered-in-error"/> 
    <display value="Entered in Error"/> 
    <definition value="This request should never have existed and should be considered 'void'.  (It is
     possible that real-world decisions were based on it.  If real-world activity has
     occurred, the status should be &quot;revoked&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 request.  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.