Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Codesystem-issue-type.xml

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: Informative

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

Definition for Code System IssueType

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

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="issue-type"/> 
  <meta> 
    <lastUpdated value="2021-12-08T19:01:54.987+11: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 http://hl7.org/fhir/issue-type defines the following codes:</p> 
      
      
      <table class="codes">
        
        
        <tr> 
          
          
          <td> 
            
            
            <b> Lvl</b> 
          
          
          </td> 
          
          
          <td style="white-space:nowrap">
            
            
            <b> Code</b> 
          
          
          </td> 
          
          
          <td> 
            
            
            <b> Display</b> 
          
          
          </td> 
          
          
          <td> 
            
            
            <b> Definition</b> 
          
          
          </td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 1</td> 
          
          
          <td style="white-space:nowrap">invalid
            
            
            <a name="issue-type-invalid"> </a> 
          
          
          </td> 
          
          
          <td> Invalid Content</td> 
          
          
          <td> Content invalid against the specification or a profile.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  structure
            
            
            <a name="issue-type-structure"> </a> 
          
          
          </td> 
          
          
          <td> Structural Issue</td> 
          
          
          <td> A structural issue in the content such as wrong namespace, unable to parse the content
             completely, invalid syntax, etc.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  required
            
            
            <a name="issue-type-required"> </a> 
          
          
          </td> 
          
          
          <td> Required element missing</td> 
          
          
          <td> A required element is missing.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  value
            
            
            <a name="issue-type-value"> </a> 
          
          
          </td> 
          
          
          <td> Element value invalid</td> 
          
          
          <td> An element or header value is invalid.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  invariant
            
            
            <a name="issue-type-invariant"> </a> 
          
          
          </td> 
          
          
          <td> Validation rule failed</td> 
          
          
          <td> A content validation rule failed - e.g. a schematron rule.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 1</td> 
          
          
          <td style="white-space:nowrap">security
            
            
            <a name="issue-type-security"> </a> 
          
          
          </td> 
          
          
          <td> Security Problem</td> 
          
          
          <td> An authentication/authorization/permissions issue of some kind.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  login
            
            
            <a name="issue-type-login"> </a> 
          
          
          </td> 
          
          
          <td> Login Required</td> 
          
          
          <td> The client needs to initiate an authentication process.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  unknown
            
            
            <a name="issue-type-unknown"> </a> 
          
          
          </td> 
          
          
          <td> Unknown User</td> 
          
          
          <td> The user or system was not able to be authenticated (either there is no process, or the
             proferred token is unacceptable).</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  expired
            
            
            <a name="issue-type-expired"> </a> 
          
          
          </td> 
          
          
          <td> Session Expired</td> 
          
          
          <td> User session expired; a login may be required.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  forbidden
            
            
            <a name="issue-type-forbidden"> </a> 
          
          
          </td> 
          
          
          <td> Forbidden</td> 
          
          
          <td> The user does not have the rights to perform this action.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  suppressed
            
            
            <a name="issue-type-suppressed"> </a> 
          
          
          </td> 
          
          
          <td> Information  Suppressed</td> 
          
          
          <td> Some information was not or might not have been returned due to business rules, consent
             or privacy rules, or access permission constraints.  This information may be accessible
             through alternate processes.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 1</td> 
          
          
          <td style="white-space:nowrap">processing
            
            
            <a name="issue-type-processing"> </a> 
          
          
          </td> 
          
          
          <td> Processing Failure</td> 
          
          
          <td> Processing issues. These are expected to be final e.g. there is no point resubmitting
             the same content unchanged.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  not-supported
            
            
            <a name="issue-type-not-supported"> </a> 
          
          
          </td> 
          
          
          <td> Content not supported</td> 
          
          
          <td> The interaction, operation, resource or profile is not supported.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  duplicate
            
            
            <a name="issue-type-duplicate"> </a> 
          
          
          </td> 
          
          
          <td> Duplicate</td> 
          
          
          <td> An attempt was made to create a duplicate record.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  multiple-matches
            
            
            <a name="issue-type-multiple-matches"> </a> 
          
          
          </td> 
          
          
          <td> Multiple Matches</td> 
          
          
          <td> Multiple matching records were found when the operation required only one match.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  not-found
            
            
            <a name="issue-type-not-found"> </a> 
          
          
          </td> 
          
          
          <td> Not Found</td> 
          
          
          <td> The reference provided was not found. In a pure RESTful environment, this would be an
             HTTP 404 error, but this code may be used where the content is not found further into
             the application architecture.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 3</td> 
          
          
          <td style="white-space:nowrap">    deleted
            
            
            <a name="issue-type-deleted"> </a> 
          
          
          </td> 
          
          
          <td> Deleted</td> 
          
          
          <td> The reference pointed to content (usually a resource) that has been deleted.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  too-long
            
            
            <a name="issue-type-too-long"> </a> 
          
          
          </td> 
          
          
          <td> Content Too Long</td> 
          
          
          <td> Provided content is too long (typically, this is a denial of service protection type of
             error).</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  code-invalid
            
            
            <a name="issue-type-code-invalid"> </a> 
          
          
          </td> 
          
          
          <td> Invalid Code</td> 
          
          
          <td> The code or system could not be understood, or it was not valid in the context of a particular
             ValueSet.code.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  extension
            
            
            <a name="issue-type-extension"> </a> 
          
          
          </td> 
          
          
          <td> Unacceptable Extension</td> 
          
          
          <td> An extension was found that was not acceptable, could not be resolved, or a modifierExtension
             was not recognized.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  too-costly
            
            
            <a name="issue-type-too-costly"> </a> 
          
          
          </td> 
          
          
          <td> Operation Too Costly</td> 
          
          
          <td> The operation was stopped to protect server resources; e.g. a request for a value set
             expansion on all of SNOMED CT.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  business-rule
            
            
            <a name="issue-type-business-rule"> </a> 
          
          
          </td> 
          
          
          <td> Business Rule Violation</td> 
          
          
          <td> The content/operation failed to pass some business rule and so could not proceed.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  conflict
            
            
            <a name="issue-type-conflict"> </a> 
          
          
          </td> 
          
          
          <td> Edit Version Conflict</td> 
          
          
          <td> Content could not be accepted because of an edit conflict (i.e. version aware updates).
             (In a pure RESTful environment, this would be an HTTP 409 error, but this code may be
             used where the conflict is discovered further into the application architecture.).</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 1</td> 
          
          
          <td style="white-space:nowrap">transient
            
            
            <a name="issue-type-transient"> </a> 
          
          
          </td> 
          
          
          <td> Transient Issue</td> 
          
          
          <td> Transient processing issues. The system receiving the message may be able to resubmit
             the same content once an underlying issue is resolved.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  lock-error
            
            
            <a name="issue-type-lock-error"> </a> 
          
          
          </td> 
          
          
          <td> Lock Error</td> 
          
          
          <td> A resource/record locking failure (usually in an underlying database).</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  no-store
            
            
            <a name="issue-type-no-store"> </a> 
          
          
          </td> 
          
          
          <td> No Store Available</td> 
          
          
          <td> The persistent store is unavailable; e.g. the database is down for maintenance or similar
             action, and the interaction or operation cannot be processed.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  exception
            
            
            <a name="issue-type-exception"> </a> 
          
          
          </td> 
          
          
          <td> Exception</td> 
          
          
          <td> An unexpected internal error has occurred.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  timeout
            
            
            <a name="issue-type-timeout"> </a> 
          
          
          </td> 
          
          
          <td> Timeout</td> 
          
          
          <td> An internal timeout has occurred.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  incomplete
            
            
            <a name="issue-type-incomplete"> </a> 
          
          
          </td> 
          
          
          <td> Incomplete Results</td> 
          
          
          <td> Not all data sources typically accessed could be reached or responded in time, so the
             returned information might not be complete (applies to search interactions and some operations).</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 2</td> 
          
          
          <td style="white-space:nowrap">  throttled
            
            
            <a name="issue-type-throttled"> </a> 
          
          
          </td> 
          
          
          <td> Throttled</td> 
          
          
          <td> The system is not prepared to handle this request due to load management.</td> 
        
        
        </tr> 
        
        
        <tr> 
          
          
          <td> 1</td> 
          
          
          <td style="white-space:nowrap">informational
            
            
            <a name="issue-type-informational"> </a> 
          
          
          </td> 
          
          
          <td> Informational Note</td> 
          
          
          <td> A message unrelated to the processing success of the completed operation (examples of
             the latter include things like reminders of password expiry, system maintenance times,
             etc.).</td> 
        
        
        </tr> 
      
      
      </table> 
    
    
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <url value="http://hl7.org/fhir/issue-type"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.411"/> 
  </identifier> 
  <version value="4.6.0"/> 
  <name value="IssueType"/> 
  <title value="IssueType"/> 
  <status value="active"/> 
  <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="A code that describes the type of issue."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/issue-type"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <concept> 
    <code value="invalid"/> 
    <display value="Invalid Content"/> 
    <definition value="Content invalid against the specification or a profile."/> 
    <concept> 
      <code value="structure"/> 
      <display value="Structural Issue"/> 
      <definition value="A structural issue in the content such as wrong namespace, unable to parse the content
       completely, invalid syntax, etc."/> 
    </concept> 
    <concept> 
      <code value="required"/> 
      <display value="Required element missing"/> 
      <definition value="A required element is missing."/> 
    </concept> 
    <concept> 
      <code value="value"/> 
      <display value="Element value invalid"/> 
      <definition value="An element or header value is invalid."/> 
    </concept> 
    <concept> 
      <code value="invariant"/> 
      <display value="Validation rule failed"/> 
      <definition value="A content validation rule failed - e.g. a schematron rule."/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="security"/> 
    <display value="Security Problem"/> 
    <definition value="An authentication/authorization/permissions issue of some kind."/> 
    <concept> 
      <code value="login"/> 
      <display value="Login Required"/> 
      <definition value="The client needs to initiate an authentication process."/> 
    </concept> 
    <concept> 
      <code value="unknown"/> 
      <display value="Unknown User"/> 
      <definition value="The user or system was not able to be authenticated (either there is no process, or the
       proferred token is unacceptable)."/> 
    </concept> 
    <concept> 
      <code value="expired"/> 
      <display value="Session Expired"/> 
      <definition value="User session expired; a login may be required."/> 
    </concept> 
    <concept> 
      <code value="forbidden"/> 
      <display value="Forbidden"/> 
      <definition value="The user does not have the rights to perform this action."/> 
    </concept> 
    <concept> 
      <code value="suppressed"/> 
      <display value="Information  Suppressed"/> 
      <definition value="Some information was not or might not have been returned due to business rules, consent
       or privacy rules, or access permission constraints.  This information may be accessible
       through alternate processes."/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="processing"/> 
    <display value="Processing Failure"/> 
    <definition value="Processing issues. These are expected to be final e.g. there is no point resubmitting
     the same content unchanged."/> 
    <concept> 
      <code value="not-supported"/> 
      <display value="Content not supported"/> 
      <definition value="The interaction, operation, resource or profile is not supported."/> 
    </concept> 
    <concept> 
      <code value="duplicate"/> 
      <display value="Duplicate"/> 
      <definition value="An attempt was made to create a duplicate record."/> 
    </concept> 
    <concept> 
      <code value="multiple-matches"/> 
      <display value="Multiple Matches"/> 
      <definition value="Multiple matching records were found when the operation required only one match."/> 
    </concept> 
    <concept> 
      <code value="not-found"/> 
      <display value="Not Found"/> 
      <definition value="The reference provided was not found. In a pure RESTful environment, this would be an
       HTTP 404 error, but this code may be used where the content is not found further into
       the application architecture."/> 
      <concept> 
        <code value="deleted"/> 
        <display value="Deleted"/> 
        <definition value="The reference pointed to content (usually a resource) that has been deleted."/> 
      </concept> 
    </concept> 
    <concept> 
      <code value="too-long"/> 
      <display value="Content Too Long"/> 
      <definition value="Provided content is too long (typically, this is a denial of service protection type of
       error)."/> 
    </concept> 
    <concept> 
      <code value="code-invalid"/> 
      <display value="Invalid Code"/> 
      <definition value="The code or system could not be understood, or it was not valid in the context of a particular
       ValueSet.code."/> 
    </concept> 
    <concept> 
      <code value="extension"/> 
      <display value="Unacceptable Extension"/> 
      <definition value="An extension was found that was not acceptable, could not be resolved, or a modifierExtension
       was not recognized."/> 
    </concept> 
    <concept> 
      <code value="too-costly"/> 
      <display value="Operation Too Costly"/> 
      <definition value="The operation was stopped to protect server resources; e.g. a request for a value set
       expansion on all of SNOMED CT."/> 
    </concept> 
    <concept> 
      <code value="business-rule"/> 
      <display value="Business Rule Violation"/> 
      <definition value="The content/operation failed to pass some business rule and so could not proceed."/> 
    </concept> 
    <concept> 
      <code value="conflict"/> 
      <display value="Edit Version Conflict"/> 
      <definition value="Content could not be accepted because of an edit conflict (i.e. version aware updates).
       (In a pure RESTful environment, this would be an HTTP 409 error, but this code may be
       used where the conflict is discovered further into the application architecture.)."/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="transient"/> 
    <display value="Transient Issue"/> 
    <definition value="Transient processing issues. The system receiving the message may be able to resubmit
     the same content once an underlying issue is resolved."/> 
    <concept> 
      <code value="lock-error"/> 
      <display value="Lock Error"/> 
      <definition value="A resource/record locking failure (usually in an underlying database)."/> 
    </concept> 
    <concept> 
      <code value="no-store"/> 
      <display value="No Store Available"/> 
      <definition value="The persistent store is unavailable; e.g. the database is down for maintenance or similar
       action, and the interaction or operation cannot be processed."/> 
    </concept> 
    <concept> 
      <code value="exception"/> 
      <display value="Exception"/> 
      <definition value="An unexpected internal error has occurred."/> 
    </concept> 
    <concept> 
      <code value="timeout"/> 
      <display value="Timeout"/> 
      <definition value="An internal timeout has occurred."/> 
    </concept> 
    <concept> 
      <code value="incomplete"/> 
      <display value="Incomplete Results"/> 
      <definition value="Not all data sources typically accessed could be reached or responded in time, so the
       returned information might not be complete (applies to search interactions and some operations)."/> 
    </concept> 
    <concept> 
      <code value="throttled"/> 
      <display value="Throttled"/> 
      <definition value="The system is not prepared to handle this request due to load management."/> 
    </concept> 
  </concept> 
  <concept> 
    <code value="informational"/> 
    <display value="Informational Note"/> 
    <definition value="A message unrelated to the processing success of the completed operation (examples of
     the latter include things like reminders of password expiry, system maintenance times,
     etc.)."/> 
  </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.