FHIR CI-Build

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

Example CodeSystem/issue-type (JSON)

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

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

Definition for Code SystemIssueType

{
  "resourceType" : "CodeSystem",
  "id" : "issue-type",
  "meta" : {
    "lastUpdated" : "2024-04-22T14:44:42.841+00:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablecodesystem"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>This case-sensitive code system <code>http://hl7.org/fhir/issue-type</code> defines the following codes in a Is-A heirarchy:</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\">\u00a0\u00a0structure<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\">\u00a0\u00a0required<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\">\u00a0\u00a0value<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\">\u00a0\u00a0invariant<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\">\u00a0\u00a0login<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\">\u00a0\u00a0unknown<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\">\u00a0\u00a0expired<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\">\u00a0\u00a0forbidden<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\">\u00a0\u00a0suppressed<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\">\u00a0\u00a0not-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\">\u00a0\u00a0duplicate<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\">\u00a0\u00a0multiple-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\">\u00a0\u00a0not-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\">\u00a0\u00a0\u00a0\u00a0deleted<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\">\u00a0\u00a0too-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\">\u00a0\u00a0code-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\">\u00a0\u00a0extension<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\">\u00a0\u00a0too-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\">\u00a0\u00a0business-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\">\u00a0\u00a0conflict<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>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0limited-filter<a name=\"issue-type-limited-filter\"> </a></td><td>Limited Filter Application</td><td>Some search filters might not have applied on all results.  Data may have been included that does not meet all of the filters listed in the `self` `Bundle.link`.</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\">\u00a0\u00a0lock-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\">\u00a0\u00a0no-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\">\u00a0\u00a0exception<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\">\u00a0\u00a0timeout<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\">\u00a0\u00a0incomplete<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\">\u00a0\u00a0throttled<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><tr><td>1</td><td style=\"white-space:nowrap\">success<a name=\"issue-type-success\"> </a></td><td>Operation Successful</td><td>The operation completed successfully.</td></tr></table></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "normative"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
    "valueCode" : "4.0.0"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 5
  }],
  "url" : "http://hl7.org/fhir/issue-type",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.4.411"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.1.400"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.2.224"
  }],
  "version" : "6.0.0-cibuild",
  "name" : "IssueType",
  "title" : "Issue Type",
  "status" : "active",
  "experimental" : false,
  "date" : "2021-01-05T10:01:24+11:00",
  "publisher" : "HL7 (FHIR Project)",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    },
    {
      "system" : "email",
      "value" : "fhir@lists.hl7.org"
    }]
  }],
  "description" : "A code that describes the type of issue.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "caseSensitive" : true,
  "valueSet" : "http://hl7.org/fhir/ValueSet/issue-type",
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "concept" : [{
    "code" : "invalid",
    "display" : "Invalid Content",
    "definition" : "Content invalid against the specification or a profile.",
    "concept" : [{
      "code" : "structure",
      "display" : "Structural Issue",
      "definition" : "A structural issue in the content such as wrong namespace, unable to parse the content completely, invalid syntax, etc."
    },
    {
      "code" : "required",
      "display" : "Required element missing",
      "definition" : "A required element is missing."
    },
    {
      "code" : "value",
      "display" : "Element value invalid",
      "definition" : "An element or header value is invalid."
    },
    {
      "code" : "invariant",
      "display" : "Validation rule failed",
      "definition" : "A content validation rule failed - e.g. a schematron rule."
    }]
  },
  {
    "code" : "security",
    "display" : "Security Problem",
    "definition" : "An authentication/authorization/permissions issue of some kind.",
    "concept" : [{
      "code" : "login",
      "display" : "Login Required",
      "definition" : "The client needs to initiate an authentication process."
    },
    {
      "code" : "unknown",
      "display" : "Unknown User",
      "definition" : "The user or system was not able to be authenticated (either there is no process, or the proferred token is unacceptable)."
    },
    {
      "code" : "expired",
      "display" : "Session Expired",
      "definition" : "User session expired; a login may be required."
    },
    {
      "code" : "forbidden",
      "display" : "Forbidden",
      "definition" : "The user does not have the rights to perform this action."
    },
    {
      "code" : "suppressed",
      "display" : "Information  Suppressed",
      "definition" : "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."
    }]
  },
  {
    "code" : "processing",
    "display" : "Processing Failure",
    "definition" : "Processing issues. These are expected to be final e.g. there is no point resubmitting the same content unchanged.",
    "concept" : [{
      "code" : "not-supported",
      "display" : "Content not supported",
      "definition" : "The interaction, operation, resource or profile is not supported."
    },
    {
      "code" : "duplicate",
      "display" : "Duplicate",
      "definition" : "An attempt was made to create a duplicate record."
    },
    {
      "code" : "multiple-matches",
      "display" : "Multiple Matches",
      "definition" : "Multiple matching records were found when the operation required only one match."
    },
    {
      "code" : "not-found",
      "display" : "Not Found",
      "definition" : "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" : "deleted",
        "display" : "Deleted",
        "definition" : "The reference pointed to content (usually a resource) that has been deleted."
      }]
    },
    {
      "code" : "too-long",
      "display" : "Content Too Long",
      "definition" : "Provided content is too long (typically, this is a denial of service protection type of error)."
    },
    {
      "code" : "code-invalid",
      "display" : "Invalid Code",
      "definition" : "The code or system could not be understood, or it was not valid in the context of a particular ValueSet.code."
    },
    {
      "code" : "extension",
      "display" : "Unacceptable Extension",
      "definition" : "An extension was found that was not acceptable, could not be resolved, or a modifierExtension was not recognized."
    },
    {
      "code" : "too-costly",
      "display" : "Operation Too Costly",
      "definition" : "The operation was stopped to protect server resources; e.g. a request for a value set expansion on all of SNOMED CT."
    },
    {
      "code" : "business-rule",
      "display" : "Business Rule Violation",
      "definition" : "The content/operation failed to pass some business rule and so could not proceed."
    },
    {
      "code" : "conflict",
      "display" : "Edit Version Conflict",
      "definition" : "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.)."
    },
    {
      "code" : "limited-filter",
      "display" : "Limited Filter Application",
      "definition" : "Some search filters might not have applied on all results.  Data may have been included that does not meet all of the filters listed in the `self` `Bundle.link`."
    }]
  },
  {
    "code" : "transient",
    "display" : "Transient Issue",
    "definition" : "Transient processing issues. The system receiving the message may be able to resubmit the same content once an underlying issue is resolved.",
    "concept" : [{
      "code" : "lock-error",
      "display" : "Lock Error",
      "definition" : "A resource/record locking failure (usually in an underlying database)."
    },
    {
      "code" : "no-store",
      "display" : "No Store Available",
      "definition" : "The persistent store is unavailable; e.g. the database is down for maintenance or similar action, and the interaction or operation cannot be processed."
    },
    {
      "code" : "exception",
      "display" : "Exception",
      "definition" : "An unexpected internal error has occurred."
    },
    {
      "code" : "timeout",
      "display" : "Timeout",
      "definition" : "An internal timeout has occurred."
    },
    {
      "code" : "incomplete",
      "display" : "Incomplete Results",
      "definition" : "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)."
    },
    {
      "code" : "throttled",
      "display" : "Throttled",
      "definition" : "The system is not prepared to handle this request due to load management."
    }]
  },
  {
    "code" : "informational",
    "display" : "Informational Note",
    "definition" : "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.)."
  },
  {
    "code" : "success",
    "display" : "Operation Successful",
    "definition" : "The operation completed successfully."
  }]
}

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.