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 R3

Example CodeSystem/response-code (XML)

Infrastructure And Messaging Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code SystemResponseType

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="response-code"/> 
  <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/response-code</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">ok
            <a name="response-code-ok"> </a> 
          </td> 
          <td> OK</td> 
          <td> The message was accepted and processed without error.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">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 style="white-space:nowrap">fatal-error
            <a name="response-code-fatal-error"> </a> 
          </td> 
          <td> Fatal Error</td> 
          <td> The message was rejected because of a problem with the content. There is no point in re-sending
             without change. The response narrative SHALL describe the issue.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="inm"/> 
  </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/response-code"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.381"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="ResponseType"/> 
  <title value="ResponseType"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2021-01-05T10:01:24+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="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 a problem with the content. 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.