STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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 R3

Codesystem-response-code.xml

Raw XML (canonical form)

Definition for Code System ResponseType

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="response-code"/>
  <meta>
    <lastUpdated value="2016-08-11T17:02:54.322+10:00"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>ResponseType</h2>
      <div>
        <p>The kind of response to a message</p>

      </div>
      <p>This code system http://hl7.org/fhir/response-code defines the following codes:</p>
      <table class="codes">
        <tr>
          <td>
            <b>Code</b>
          </td>
          <td>
            <b>Display</b>
          </td>
          <td>
            <b>Definition</b>
          </td>
        </tr>
        <tr>
          <td>ok
            <a name="response-code-ok"> </a>
          </td>
          <td>OK</td>
          <td>The message was accepted and processed without error.</td>
        </tr>
        <tr>
          <td>transient-error
            <a name="response-code-transient-error"> </a>
          </td>
          <td>Transient Error</td>
          <td>Some internal unexpected error occurred - wait and try again. Note - this is usually used
             for things like database unavailable, which may be expected to resolve, though human intervention
             may be required.</td>
        </tr>
        <tr>
          <td>fatal-error
            <a name="response-code-fatal-error"> </a>
          </td>
          <td>Fatal Error</td>
          <td>The message was rejected because of some content in it. There is no point in re-sending
             without change. The response narrative SHALL describe the issue.</td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/response-code"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.1.203"/>
  </identifier>
  <version value="1.6.0"/>
  <name value="ResponseType"/>
  <status value="draft"/>
  <experimental value="false"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <date value="2016-08-11T17:02:54+10:00"/>
  <description value="The kind of response to a message"/>
  <caseSensitive value="true"/>
  <valueSet value="http://hl7.org/fhir/ValueSet/response-code"/>
  <content value="complete"/>
  <concept>
    <code value="ok"/>
    <display value="OK"/>
    <definition value="The message was accepted and processed without error."/>
  </concept>
  <concept>
    <code value="transient-error"/>
    <display value="Transient Error"/>
    <definition value="Some internal unexpected error occurred - wait and try again. Note - this is usually used
     for things like database unavailable, which may be expected to resolve, though human intervention
     may be required."/>
  </concept>
  <concept>
    <code value="fatal-error"/>
    <display value="Fatal Error"/>
    <definition value="The message was rejected because of some content in it. There is no point in re-sending
     without change. The response narrative SHALL describe the issue."/>
  </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.