STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Operation-task-fail.xml

Raw XML (canonical form)

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Task-fail"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Fail Task</h2>
      <p>OPERATION: Fail Task</p>
      <div>
        <p>Fail this task.  The task is transitioned to the failed state.</p>

      </div>
      <p>URL: [base]/Task/[id]/$fail</p>
      <p>Parameters</p>
      <table class="grid">
        <tr>
          <td>
            <b>Use</b>
          </td>
          <td>
            <b>Name</b>
          </td>
          <td>
            <b>Cardinality</b>
          </td>
          <td>
            <b>Type</b>
          </td>
          <td>
            <b>Binding</b>
          </td>
          <td>
            <b>Documentation</b>
          </td>
        </tr>
        <tr>
          <td>IN</td>
          <td>reason</td>
          <td>0..1</td>
          <td>CodeableConcept</td>
          <td/>
          <td>
            <div>
              <p>The reason for failure.  If present, this is assigned to the failureReason property of
                 the task.</p>

            </div>
          </td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/Task-fail"/>
  <name value="Fail Task"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2016-12-06T12:22:34+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="Fail this task.  The task is transitioned to the failed state."/>
  <code value="fail"/>
  <resource value="Task"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="reason"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="The reason for failure.  If present, this is assigned to the failureReason property of
     the task."/>
    <type value="CodeableConcept"/>
  </parameter>
</OperationDefinition>

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.